/trestle-bot

https://github.com/IBM/compliance-trestle workflow automation bot

Primary LanguagePythonApache License 2.0Apache-2.0

trestle-bot

trestle-bot assists users in leveraging Compliance-Trestle in automated workflows or OSCAL formatted compliance content management.

In addition to trestle-bot, this repo contains the trestle-bot GitHub Action that can optionally be used to host the tresle-bot service within GitHub Actions.

WARNING: This project is under active development.

Usage

trestle-bot supports the following commands:

/assemble

Converts repo defined markdown formatted OSCAL content to JSON.

/help

Displays help information for trestle-bot.

Contributing

Format and Styling

make format
make lint

Running tests

make test

Run with poetry

poetry run trestle-bot

Additional information on workflow inputs

  • markdown_path: This is the location for Markdown generated by the trestle author <model>-generate commands
  • ssp_index_path: This is a text file that stores the component definition information by name in trestle with the ssp name. Each line should look like ssp:mycomp