mirror of
https://github.com/strongdm/comply
synced 2024-11-05 15:35:25 +00:00
Merge pull request #82 from adamdecaf/docs-github-config
docs: add section for github ticketing config
This commit is contained in:
commit
34c0105b47
19
README.md
19
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: <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
|
||||
|
Loading…
Reference in New Issue
Block a user