Merge pull request #422 from qduanmu/github-templates

fix: fix github doc and templates
complytime · Jan 21, 2025 · a4c5840 · a4c5840
2 parents d901a76 + c9333b6
commit a4c5840
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git 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
@@ -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]"
+          markdown_dir: "markdown/component-definitions"
+          commit_message: "Auto-transform rules [skip ci]"
diff --git 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 <path-to-your-repo>
+trestlebot init --repo-path <path-to-your-repo>
 ```
 
 1b. Running trestlebot init using a trestle-bot container image:
@@ -56,13 +56,14 @@ podman run -v <path-to-your-repo>:/data:Z  trestle-bot:<tag> --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.