README.md in agile_notifier-2.0 vs README.md in agile_notifier-2.1
- old
+ new
@@ -16,32 +16,32 @@
ci_job 'your-project-continuous-build'
ci_get 'Jenkins'
scm_url 'https://github.xyzcompany.com'
scm_repo user: 'your_user_name', repo: 'your_repository_name'
+ # scm_auth is optional, depends on if your github API access requires authentication
+ # if authentication is required, please choose either username & password or OAuth access token (latter one is recommended)
+ scm_auth username: 'github_login_username', password: 'github_login_password' # optional
+ scm_auth token: 'a1b2c3d4e5f6f0f0f0f0f0f0f0f0f6e5d4c3b2a1' # optional
scm_get 'Github', enterprise: true
# for non-enterprise version
# scm_url 'https://api.github.com'
# scm_repo user: 'your_user_name', repo: 'your_repository_name'
# scm_get 'Github'
-
- speak 'en'
- play 'Boing' # Mac OSX TTS voice name(optional field), unnecessary for other OS
-
- alert_on_fail
- alert_on_fix
- alert_on_unstable
its_url 'https://jira.atlassian.com'
its_auth 'jira_username', 'jira_password'
its_get 'Jira'
its_set_wip 'BAM', 'project = BAM AND status = Resolved AND resolution = Unresolved', 3
its_set_wip 'XXX', 'project = XXX AND status = Resolved AND resolution = Unresolved', 5
-
+
speak 'en'
- play 'Alex'
-
+ play 'Boing' # Mac OSX TTS voice name(optional field), unnecessary for other OS
+
+ alert_on_fail
+ alert_on_fix
+ alert_on_unstable
alert_on_wip
end
```
## Notes: