Skip to content

fix: fix github doc and templates #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions TEMPLATES/github/trestlebot-create-component-definition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
6 changes: 3 additions & 3 deletions TEMPLATES/github/trestlebot-rules-transform.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]"
11 changes: 6 additions & 5 deletions docs/tutorials/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down
Loading