Github
/
comply
mirror of https://github.com/strongdm/comply
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README to clarify github config attributes

This commit is contained in:
Darwin D Wu 2022-07-21 00:18:38 -07:00
parent 29b667f624
commit 5371b7c8a4
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -127,11 +127,14 @@ Ticketing integration with GitHub can be configured with the following YAML in `
```yaml
tickets:
github:
repo: github.com/your-org/SOC2
repo: <repo-name>
token: <token>
username: org-bot-user
username: org or personal username
```
If you're setting up the repo in your personal account, set `username` to your username.
If you're setting up the repo in an github organization, set `username` to your org's username instead.
Also, `GITHUB_REPO`, `GITHUB_TOKEN`, and `GITHUB_USERNAME` can be used to override values from the YAML file.
### Jira