-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -73,7 +73,7 @@ For workflow diagrams, see the [diagrams](./docs/workflows/) under the `docs` fo | |
#### Code structure | ||
|
||
- `actions` - Provides specific logic for `trestle-bot` tasks that are packaged as Actions. See [README.md](./actions/README.md) for more information. | ||
- `entrypoints` - Provides top level logic for specific user-facing tasks. These tasks are not necessarily related in any way so they are not organized into a hierarchical command structure, but they do inherit logic and flags from a base class. | ||
- `cli` - Provides top level logic for specific user-facing tasks. These tasks are not necessarily related so they are not organized into a hierarchical command structure, but they do share some common modules. | ||
- `provider.py, github.py, and gitlab.py` - Git provider abstract class and concrete implementations for interacting with the API. | ||
- `tasks` - Pre-tasks can be configured before the main git logic is run. Any task that does workspace management should go here. | ||
- `tasks/authored` - The `authored` package contains logic for managing authoring tasks for single instances of a top-level OSCAL model. These encapsulate logic from the `compliance-trestle` library and allows loose coupling between `tasks` and `authored` types. | ||
|
@@ -109,7 +109,7 @@ To generate a pin for a third party action, there should be a full length commit | |
|
||
This approach is used for authoring CI workflows that utilize versioned actions to produce frequent updates from dependabot for python and GitHub Actions. | ||
|
||
### License Text in Files | ||
### License Text in Files | ||
|
||
Please use the SPDX license identifier in all source files. | ||
|
||
|
@@ -158,11 +158,11 @@ make test-e2e | |
#### Run with poetry | ||
``` | ||
make develop | ||
poetry run trestlebot-autosync | ||
poetry run trestlebot-rules-transform | ||
poetry run trestlebot-create-cd | ||
poetry run trestlebot-sync-upstreams | ||
poetry run trestlebot-create-ssp | ||
poetry run trestlebot autosync | ||
poetry run trestlebot rules-transform | ||
poetry run trestlebot create compdef | ||
poetry run trestlebot sync-upstreams | ||
poetry run trestlebot create ssp | ||
``` | ||
|
||
#### Local testing | ||
|
@@ -190,15 +190,15 @@ INPUT_SKIP_ITEMS= | |
INPUT_DRY_RUN=true | ||
INPUT_SKIP_ASSEMBLE=false | ||
INPUT_SKIP_REGENERATE=false | ||
INPUT_REPOSITORY=. | ||
INPUT_REPO_PATH=. | ||
INPUT_BRANCH=test | ||
INPUT_MARKDOWN_PATH=markdown/profiles | ||
INPUT_MARKDOWN_DIR=markdown/profiles | ||
INPUT_OSCAL_MODEL=profile | ||
INPUT_SSP_INDEX_PATH= | ||
INPUT_SSP_INDEX_FILE= | ||
INPUT_COMMIT_MESSAGE= | ||
INPUT_COMMIT_USER_NAME=testuser | ||
[email protected] | ||
INPUT_FILE_PATTERN=*.md,*.json | ||
INPUT_FILE_PATTERNS=*.md,*.json | ||
INPUT_COMMIT_AUTHOR_NAME= | ||
INPUT_COMMIT_AUTHOR_EMAIL= | ||
INPUT_TARGET_BRANCH= | ||
|
@@ -228,4 +228,4 @@ Once work on a release has been completed: | |
- Initial releases will have a `major` tag (if stable), `major`.`minor`, and the full version. | ||
- The latest release will be rebuilt every thirty days to pull in base image updates. The same tags will | ||
be published with the addition of `full-version`.`date` tag. | ||
- Images can be built adhoc for testing purposes with the `workflow_dispatch` trigger. | ||
- Images can be built adhoc for testing purposes with the `workflow_dispatch` trigger. |