From c9333b6f90cf19b8836b8aa88f8554472d76a7a6 Mon Sep 17 00:00:00 2001 From: Qingmin Duanmu Date: Fri, 17 Jan 2025 17:02:50 +0800 Subject: [PATCH] fix: fix github doc and templates --- .../github/trestlebot-create-component-definition.yml | 5 ++--- TEMPLATES/github/trestlebot-rules-transform.yml | 6 +++--- docs/tutorials/github.md | 11 ++++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/TEMPLATES/github/trestlebot-create-component-definition.yml b/TEMPLATES/github/trestlebot-create-component-definition.yml index 4c4bf0f7..38495136 100644 --- a/TEMPLATES/github/trestlebot-create-component-definition.yml +++ b/TEMPLATES/github/trestlebot-create-component-definition.yml @@ -40,10 +40,9 @@ jobs: component_title: ${{ github.event.inputs.component_title }} component_type: ${{ github.event.inputs.component_type }} component_description: ${{ github.event.inputs.component_description }} - markdown_path: "markdown/component-definitions" + markdown_dir: "markdown/component-definitions" branch: "create-component-definition-${{ github.run_id }}" target_branch: "main" - file_pattern: "*.json,markdown/*,rules/*" + file_patterns: "*.json,markdown/*,rules/*" commit_message: "adds component ${{ github.event.inputs.component_title }} in ${{ github.event.inputs.component_definition_name }}" - pull_request_title: "Add component ${{ github.event.inputs.component_title }} to ${{ github.event.inputs.component_definition_name }}" github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/TEMPLATES/github/trestlebot-rules-transform.yml b/TEMPLATES/github/trestlebot-rules-transform.yml index 761f2c6f..984a3c75 100644 --- a/TEMPLATES/github/trestlebot-rules-transform.yml +++ b/TEMPLATES/github/trestlebot-rules-transform.yml @@ -42,12 +42,12 @@ jobs: id: autosync uses: RedHatProductSecurity/trestle-bot/actions/autosync@main with: - markdown_path: "markdown/component-definitions" + markdown_dir: "markdown/component-definitions" oscal_model: "compdef" commit_message: "Autosync component definition content [skip ci]" - name: Rules Transform if: needs.check_rules.outputs.rules_changed == 'true' uses: RedHatProductSecurity/trestle-bot/actions/rules-transform@main with: - markdown_path: "markdown/component-definitions" - commit_message: "Auto-transform rules [skip ci]" \ No newline at end of file + markdown_dir: "markdown/component-definitions" + commit_message: "Auto-transform rules [skip ci]" diff --git a/docs/tutorials/github.md b/docs/tutorials/github.md index 5c08868e..9f9a7eca 100644 --- a/docs/tutorials/github.md +++ b/docs/tutorials/github.md @@ -36,7 +36,7 @@ For this tutorial example, we will be authoring a component-definition. 1a. Running trestlebot init using a locally installed trestlebot: ``` -trestlebot-init --oscal-model compdef --working-dir +trestlebot init --repo-path ``` 1b. Running trestlebot init using a trestle-bot container image: @@ -56,13 +56,14 @@ podman run -v :/data:Z trestle-bot: --oscal-model compd ```bash . +├── assessment-plans +├── assessment-results ├── catalogs ├── component-definitions -├── markdown +├── markdown +├── plan-of-action-and-milestones ├── profiles -├── rules -├── .trestle -└── .trestlebot +└── system-security-plans ``` 2. Any catalog or profile content needed for the authoring process can now be added.