1
0
mirror of https://github.com/strongdm/comply synced 2024-06-30 22:14:22 +00:00

docs: add section for github ticketing config

Issue: https://github.com/strongdm/comply/issues/81
This commit is contained in:
Adam Shannon 2019-12-26 16:05:32 -06:00
parent c5a1bd804b
commit d6d12c3206

View File

@ -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: <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