diff --git a/README.md b/README.md index 575c27e..1eb79d7 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,24 @@ For Windows users, replace $PWD with the full path to your project directory - Github - Gitlab -## Configuring Jira +## Configuration + +## GitHub + +Ticketing integration with GitHub can be configured with the following YAML in `comply.yml`: + +```yaml +tickets: + github: + repo: github.com/your-org/SOC2 + token: + username: org-bot-user +``` + +Also, `GITHUB_REPO`, `GITHUB_TOKEN`, and `GITHUB_USERNAME` can be used to override values from the YAML file. + +### Jira + When comply creates a ticket (through `proc`, for instance), it sets the following fields. - assignee