From 4e80ac0a7771c6c46f44cd85db00002a3a5fca0c Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Thu, 10 Aug 2023 22:30:08 +0530 Subject: [PATCH] Add information about the feature in readme --- .github/.jira_sync_config.yaml | 2 +- readme.rst | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/.jira_sync_config.yaml b/.github/.jira_sync_config.yaml index f2969932..2be7bbd7 100644 --- a/.github/.jira_sync_config.yaml +++ b/.github/.jira_sync_config.yaml @@ -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 diff --git a/readme.rst b/readme.rst index 3104e60c..58e84fa9 100644 --- a/readme.rst +++ b/readme.rst @@ -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 `_ +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 `_ +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 ----------