trestle-bot assists users in leveraging Compliance-Trestle in CI/CD workflows for OSCAL formatted compliance content management.
WARNING: This project is currently under initial development. APIs may be changed incompatibly from one commit to another.
For detailed documentation on how to use each action, see the README.md in each folder under actions.
The autosync action will sync trestle-generated Markdown files to OSCAL JSON files in a trestle workspace. All content under the provided markdown directory when the action is run will be transformed. This action supports all top-level models supported by compliance-trestle for authoring.
The rules-transform action can be used when managing OSCAL Component Definitions in a trestle workspace. The action will transform rules defined in the rules YAML view to an OSCAL Component Definition JSON file.
The create-cd action can be used to create a new OSCAL Component Definition in a trestle workspace. The action will create a new Component Definition JSON file and corresponding directories that contain rules YAML files and trestle-generated Markdown files. This action prepares the workspace for use with the rules-transform and autosync actions.
Coming Soon
Build and run the container locally:
podman build -f Dockerfile -t trestle-bot .
podman run -v $(pwd):/data -w /data trestle-botContainer images are available in quay.io:
podman run -v $(pwd):/data -w /data quay.io/continuouscompliance/trestle-bot:<tag>For information about contributing to trestle-bot, see the CONTRIBUTING.md file.
This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.
See TROUBLESHOOTING.md for troubleshooting tips.