Merge pull request #129 from darwin67/master

Update README to clarify github config attributes
2022-07-21 10:02:53 +02:00 · 2022-07-21 00:18:38 -07:00
1 changed files with 5 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -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
Author	SHA1	Message	Date
Rodolfo Campos	aab484948d	Merge pull request #129 from darwin67/master Update README to clarify github config attributes	2022-07-21 10:02:53 +02:00
Darwin D Wu	5371b7c8a4	Update README to clarify github config attributes	2022-07-21 00:18:38 -07:00