Skip to content

Commit

Permalink
Add information about the feature in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
keirthana committed Aug 10, 2023
1 parent a5d45e0 commit 4e80ac0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/.jira_sync_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ settings:
# Dictionary mapping GitHub issue status to Jira issue status
status_mapping:
opened: Untriaged
closed: done
closed: Done

# (Optional) Jira project components that should be attached to the created issue
# Component names are case-sensitive
Expand Down
14 changes: 14 additions & 0 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,20 @@ Add custom configuration
To add custom configurations for your project, see the ``Additions to default configuration`` and ``Additional configuration`` sections in the ``custom_conf.py`` file.
These can be used to extend or override the common configuration, or to define additional configuration that is not covered by the common ``conf.py`` file.

(Optional) Synchronise GitHub issues to Jira
--------------------------------------------

If you wish to sync issues from your documentation repository on GitHub to your
Jira board, configure the `gh-jira-sync-bot <https://github.com/canonical/gh-jira-sync-bot>`_
by editing the ``.github/workflows/.jira_sync_config.yaml`` file appropriately.
In addition to updating this file, you must also apply server configuration
for this feature to work. For more information, see `server configuration details <https://github.com/canonical/gh-jira-sync-bot#server-configuration>`_
for the gh-jira-sync-bot.

By default, this file in the starter pack contains configuration for syncing
issues from the starter pack repository to its documentation Jira board and
hence does not work out of the box for other repositories in GitHub.

Change log
----------

Expand Down

0 comments on commit 4e80ac0

Please sign in to comment.