Skip to content
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.

Sign up for GitHub

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

docs: remove TEMPLATES directory and update github tutorial #376

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −215
Open

docs: remove TEMPLATES directory and update github tutorial #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 0 additions & 8 deletions TEMPLATES/README.md
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions TEMPLATES/github/trestlebot-autosync-catalog.yml
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions TEMPLATES/github/trestlebot-autosync-profile.yml
View file
Open in desktop

This file was deleted.

32 changes: 0 additions & 32 deletions TEMPLATES/github/trestlebot-autosync-ssp.yml
View file
Open in desktop

This file was deleted.

49 changes: 0 additions & 49 deletions TEMPLATES/github/trestlebot-create-component-definition.yml
View file
Open in desktop

This file was deleted.

53 changes: 0 additions & 53 deletions TEMPLATES/github/trestlebot-rules-transform.yml
View file
Open in desktop

This file was deleted.

15 changes: 4 additions & 11 deletions docs/tutorials/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,20 +87,13 @@ wget https://raw.githubusercontent.com/usnistgov/oscal-content/release-v1.0.5-up
sed -i 's/NIST_SP-800-53_rev5_catalog.json/trestle:\/\/catalogs\/nist_rev5_800_53\/catalog.json/g' profiles/nist_rev5_800_53/profile.json
```

4. Ready-made CI/CD workflows can be copied from the `TEMPLATES` directory within the upstream `trestle-bot` repository into the local trestle workspace. These are the trestlebot actions that will run as changes are made to the repo contents.
4. Ready-made CI/CD workflows can be copied from the `.github/workflows/` directory within the upstream `trestle-demo` repository into the local trestle workspace. These are the trestlebot actions that will run as changes are made to the repo contents.

* If trestlebot init was run earlier using a trestle-bot container image, then the upstream trestle-bot repository will first need to be cloned locally into a separate directory.
```
cd ..
git clone https://github.com/RedHatProductSecurity/trestle-bot.git
cd ../<trestle_workspace_repo>
```

* Copy the required template workflows from the separate `trestle-bot` repository into the new workspace repository.
* Copy the required template workflows from the `trestle-demo` repository into the new workspace repository.
```
mkdir -p .github/workflows
cp ../trestle-bot/TEMPLATES/github/trestlebot-create-component-definition.yml .github/workflows
cp ../trestle-bot/TEMPLATES/github/trestlebot-rules-transform.yml .github/workflows
wget -O .github/workflows/trestlebot-rules-transform.yml https://raw.githubusercontent.com/RedHatProductSecurity/trestle-demo/refs/heads/main/.github/workflows/trestlebot-rules-transform.yml
wget -O .github/workflows/trestlebot-create-component-definition.yml https://raw.githubusercontent.com/RedHatProductSecurity/trestle-demo/refs/heads/main/.github/workflows/trestlebot-create-component-definition.yml
```

5. Trestle-bot initial content is now created locally within the new trestle authoring workspace. This content can now be pushed to the remote GitHub repository.
Expand Down