Skip to content

Commit

Permalink
docs: adds steps for running as a container to README.md getting started
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Oct 12, 2023
1 parent 075c527 commit 1b85b71
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ When submitting a pull request, please follow these guidelines:
2. Ensure that your code passes all CI tests.
3. Please keep the pull request focused on a single issue or feature, if possible.

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE) file for details.

## Developer Guide

## Prerequisites
Expand Down Expand Up @@ -68,7 +64,10 @@ make test

### Run with poetry
```
poetry run trestle-bot
poetry shell
poetry install
poetry run trestlebot-autosync
poetry run trestlebot-rules-transform
```

### Local testing
Expand Down Expand Up @@ -125,4 +124,4 @@ podman run --entrypoint /entrypoint.sh --secret repo-secret,type=env,target=GITH

### Adding a new action

First, create an entrypoint script for the new action in the `trestlebot/infra` directory. Then add the action by creating a new directory in the `actions` directory with an `action.yml` that references your new entrypoint.
First, create an entrypoint script for the new action in the `trestlebot/entrypoints` directory. Then add the action by creating a new directory in the `actions` directory with an `action.yml` that references your new entrypoint.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# trestle-bot

trestle-bot assists users in leveraging [Compliance-Trestle](https://github.com/IBM/compliance-trestle) in automated workflows for [OSCAL](https://github.com/usnistgov/OSCAL) formatted compliance content management.
trestle-bot assists users in leveraging [Compliance-Trestle](https://github.com/IBM/compliance-trestle) in CI/CD workflows for [OSCAL](https://github.com/usnistgov/OSCAL) formatted compliance content management.

> WARNING: This project is currently under initial development. APIs may be changed incompatibly from one commit to another.
## Getting Started

## GitHub Actions
### GitHub Actions

For detailed documentation on how to use each action see the README.md each each folder under [actions](./actions/).

Expand All @@ -18,8 +18,29 @@ The `rules-transform` actions can be used when managing [OSCAL Component Definit

> Coming Soon
### Run as a Container

Build and run the container locally:

```bash
podman build -f Dockerfile -t trestle-bot .
podman run -v $(pwd):/data -w /data trestle-bot
```

Container images are available in `quay.io`:

```bash
podman run -v $(pwd):/data -w /data quay.io/continuouscompliance/trestle-bot:<tag>
```

## Contributing

For information about contributing to trestle-bot see the [contributing guide](./CONTRIBUTING.md)
For information about contributing to trestle-bot see the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE) file for details.

## Troubleshooting

See `TROUBLESHOOTING.md` for additional information.
See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for troubleshooting tips.

0 comments on commit 1b85b71

Please sign in to comment.