Merge pull request #129 from darwin67/master

Update README to clarify github config attributes
This commit is contained in:
Rodolfo Campos 2022-07-21 10:02:53 +02:00 committed by GitHub
commit aab484948d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions

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