summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@qt.io>2019-03-29 12:57:23 +0100
committerFrederik Gladhorn <frederik.gladhorn@qt.io>2019-04-01 08:28:39 +0000
commitd7dc70e2015a9881751e8057aa61a980a3a0bcad (patch)
treee881fd048c35d11934539e0dfa314d00a58b146b
parentecd6feadd5ad97252c929f7cecc48fcdfe474846 (diff)
Improve readme
Change-Id: I74370b90cf13cee12bf5581472a69151b1b21966 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@qt.io>
-rw-r--r--scripts/jira/jira-bug-closer/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/scripts/jira/jira-bug-closer/README.md b/scripts/jira/jira-bug-closer/README.md
index 0b261a3c..8ddd271d 100644
--- a/scripts/jira/jira-bug-closer/README.md
+++ b/scripts/jira/jira-bug-closer/README.md
@@ -1,6 +1,6 @@
# JIRA bot to close issues
-Listen to gerrit events and close corresponding JIRA tasks when there is a fixes tag in the commit message.
+Listen to gerrit events and close corresponding JIRA tasks when there is a "Fixes:" footer in the commit message.
## Prerequisites and building
@@ -9,7 +9,7 @@ Run `make` to install dependencies.
## Connecting to a JIRA account using OAuth
-* Generate a private/public rsa certificate pair (`jiracloser.pem`, `jiracloser.pub`)
+* Generate a private/public rsa certificate pair (`jiracloser.pem`, `jiracloser.pub`) in the root directory (next to this readme file).
* See for example https://www.madboa.com/geek/openssl/#key-rsa
* Log in to JIRA as admin.
@@ -20,7 +20,7 @@ Run `make` to install dependencies.
* Type: Generic
* Service Provider Name: Qt JIRA bot (anything goes)
* Consumer key: jira-gerrit-bot-oauth-consumer
- * Shared Secret: 8aG2#dwV24$e9J43@s8b
+ * Shared Secret: 8aG2#dwV24$e9J43@s8b # this is actually unused, put some random garbage here to make sure
* Request Token URL: https://www.qt.io
* Access token URL: https://www.qt.io
* Authorize URL: https://www.qt.io