Skip to content

Commit

Permalink
docs: updates docs to remove check_only references
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Mar 29, 2024
1 parent 7460baf commit bf72326
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ cat envfile
GITHUB_OUTPUT=
INPUT_SKIP_ITEMS=
INPUT_CHECK_ONLY=true
INPUT_DRY_RUN=true
INPUT_SKIP_ASSEMBLE=false
INPUT_SKIP_REGENERATE=false
INPUT_REPOSITORY=.
Expand Down
4 changes: 2 additions & 2 deletions actions/autosync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The purpose of this action is to sync JSON and Markdown data with `compliance-tr
github_token: ${{ secret.GITHUB_TOKEN }}
```

- When `check_only` is set, the trestle `assemble` and `regenerate` tasks are run and the repository is checked for changes. If changes exists, the action with exit with an error. This can be useful if you only want to check that the content is in sync without making any changes to the remote repository.
- When `dry_run` is set, the trestle `assemble` and `regenerate` tasks are run and no commit is made If changes exists, with display the files that would be changed.

```yaml
steps:
Expand All @@ -117,7 +117,7 @@ The purpose of this action is to sync JSON and Markdown data with `compliance-tr
with:
markdown_path: "markdown/profiles"
oscal_model: "profile"
check_only: true
dry_run: true
```

> Note: Trestle `assemble` or `regenerate` tasks may be skipped if desired using `skip_assemble: true` or `skip_regenerate: true`, respectively.

0 comments on commit bf72326

Please sign in to comment.