Skip to content

Commit 650c1ae

Browse files
committed
updated README.rst for v0.2.0
1 parent 9f9b65d commit 650c1ae

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Add this to your ``.pre-commit-config.yaml``:
2020
.. code-block:: yaml
2121
2222
- repo: https://github.com/Cielquan/commit-msg-jira-hook
23-
rev: v0.1.0 # Use the ref you want to point at
23+
rev: v0.2.0 # Use the ref you want to point at
2424
hooks:
2525
- id: jira_commit_msg
2626
stages: [commit-msg]
@@ -32,11 +32,19 @@ Then add a ``jira.ini`` to you projects root directory with following data:
3232
[jira]
3333
JIRA_URL = e.g. https://jira.atlassian.com
3434
JIRA_TAG = tag
35+
36+
Then add a ``.jira.ini`` to your home direcotry with the following data:
37+
38+
.. code-block:: ini
39+
40+
[jira]
3541
JIRA_USERNAME = email
3642
JIRA_TOKEN = api-token
3743
3844
Get api token from here: https://id.atlassian.com/manage/api-tokens
3945

46+
The split into two ``*.ini`` files is so you do not commit your credentials into your repo.
47+
4048
Lastly install the hook:
4149

4250
.. code-block:: console

0 commit comments

Comments
 (0)