Skip to content

Commit

Permalink
updated README.rst for v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Cielquan committed Feb 6, 2020
1 parent 9f9b65d commit 650c1ae
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Add this to your ``.pre-commit-config.yaml``:
.. code-block:: yaml
- repo: https://github.com/Cielquan/commit-msg-jira-hook
rev: v0.1.0 # Use the ref you want to point at
rev: v0.2.0 # Use the ref you want to point at
hooks:
- id: jira_commit_msg
stages: [commit-msg]
Expand All @@ -32,11 +32,19 @@ Then add a ``jira.ini`` to you projects root directory with following data:
[jira]
JIRA_URL = e.g. https://jira.atlassian.com
JIRA_TAG = tag
Then add a ``.jira.ini`` to your home direcotry with the following data:

.. code-block:: ini
[jira]
JIRA_USERNAME = email
JIRA_TOKEN = api-token
Get api token from here: https://id.atlassian.com/manage/api-tokens

The split into two ``*.ini`` files is so you do not commit your credentials into your repo.

Lastly install the hook:

.. code-block:: console
Expand Down

0 comments on commit 650c1ae

Please sign in to comment.