Skip to content

Commit

Permalink
docs: align terminology with trestle-bot command names
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed May 22, 2024
1 parent 61238af commit cc9b7f5
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Profile Autofix
name: Profile autosync

on:
workflow_call:
Expand All @@ -13,7 +13,7 @@ concurrency:

jobs:
auto-update:
name: Autofix profile content
name: autosync profile content
runs-on: ubuntu-latest
steps:
- name: Generate app token
Expand All @@ -29,8 +29,8 @@ jobs:
with:
ref: ${{ inputs.branch }}
token: ${{ steps.get_installation_token.outputs.token }}
- name: Autofix profile
id: autofix-profile
- name: autosync profile
id: autosync-profile
uses: RedHatProductSecurity/trestle-bot/actions/[email protected]
with:
markdown_path: "markdown/profiles"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Run autofix adhoc
name: Run autosync adhoc

on:
workflow_dispatch:

jobs:
call-autofix:
uses: ./.github/workflows/autofix-profile.yml
call-autosync:
uses: ./.github/workflows/autosync-profile.yml
with:
branch: ${{ github.ref_name }}
secrets: inherit
4 changes: 2 additions & 2 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ jobs:
check_only: true
skip_items: "fedramp_rev5_high"

call-autofix:
call-autosync:
needs: [test]
if: |
always() && contains(needs.*.result, 'failure')
&& github.event.pull_request.base.repo.url == github.event.pull_request.head.repo.url
uses: ./.github/workflows/autofix-profile.yml
uses: ./.github/workflows/autosync-profile.yml
with:
branch: ${{ github.head_ref }}
secrets: inherit
10 changes: 5 additions & 5 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ Associated Workflows

The `create-new` workflow is triggered manually by going to the Action tab. This creates a new OSCAL profile in the trestle workspace. A new branch is created and a pull request is opened.

#### AutoFix
#### Autosync content

Associated Workflows
- [autofix-profile.yml](../.github/workflows/autofix-profile.yml)
- [manual-autofix.yml](../.github/workflows/manual-autofix.yml)
- [autosync-profile.yml](../.github/workflows/autosync-profile.yml)
- [manual-autosync.yml](../.github/workflows/manual-autosync.yml)
- [validate.yml](../.github/workflows/validate.yml)

The `validate` workflow is triggered when a pull request is created or updated with updates to component definitions. It validates the trestle workspace and automatically sync any difference between the OSCAL JSON files and trestle managed Markdown files. The same workflow can be triggered through the Action tab using the `Run autofix adhoc` workflow. The `autofix-profile.yml` has all common logic for both workflows. The `validate.yml` and `manual-autofix.yml` workflows adds customer triggers and logic.
The `validate` workflow is triggered when a pull request is created or updated with updates to component definitions. It validates the trestle workspace and automatically sync any difference between the OSCAL JSON files and trestle managed Markdown files. The same workflow can be triggered through the Action tab using the `Run autosync adhoc` workflow. The `autosync-profile.yml` has all common logic for both workflows. The `validate.yml` and `manual-autosync.yml` workflows adds customer triggers and logic.

The `validate` workflow will run checks with read-only permissions when a pull request is opened from a from a fork, but the autofix workflow will not run.
The `validate` workflow will run checks with read-only permissions when a pull request is opened from a from a fork, but the autosync workflow will not run.

#### Update Profile

Expand Down

0 comments on commit cc9b7f5

Please sign in to comment.