From cc9b7f50297276b2699d92f78ad2d6756f38ab95 Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Wed, 22 May 2024 14:55:32 -0400 Subject: [PATCH] docs: align terminology with trestle-bot command names Signed-off-by: Jennifer Power --- .../{autofix-profile.yml => autosync-profile.yml} | 8 ++++---- .../{manual-autofix.yml => manual-autosync.yml} | 6 +++--- .github/workflows/validate.yml | 4 ++-- docs/design.md | 10 +++++----- 4 files changed, 14 insertions(+), 14 deletions(-) rename .github/workflows/{autofix-profile.yml => autosync-profile.yml} (90%) rename .github/workflows/{manual-autofix.yml => manual-autosync.yml} (51%) diff --git a/.github/workflows/autofix-profile.yml b/.github/workflows/autosync-profile.yml similarity index 90% rename from .github/workflows/autofix-profile.yml rename to .github/workflows/autosync-profile.yml index 73a82f4..f489207 100644 --- a/.github/workflows/autofix-profile.yml +++ b/.github/workflows/autosync-profile.yml @@ -1,4 +1,4 @@ -name: Profile Autofix +name: Profile autosync on: workflow_call: @@ -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 @@ -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/autosync@v0.8.0 with: markdown_path: "markdown/profiles" diff --git a/.github/workflows/manual-autofix.yml b/.github/workflows/manual-autosync.yml similarity index 51% rename from .github/workflows/manual-autofix.yml rename to .github/workflows/manual-autosync.yml index d60b5f4..e6623cb 100644 --- a/.github/workflows/manual-autofix.yml +++ b/.github/workflows/manual-autosync.yml @@ -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 \ No newline at end of file diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 3777c19..3d635e4 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -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 \ No newline at end of file diff --git a/docs/design.md b/docs/design.md index 9732c85..3817288 100644 --- a/docs/design.md +++ b/docs/design.md @@ -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