Jirasync is a CLI tool which collects all GitHub Issues, PR, PR_Reviews and Create them as Jira tasks. It will handle the whole lifecycle of jira task from Assigment => Adding to Current Sprint => Updating correct status. Currently, it is designed for a Single User and MultiUser who wants syncs his GitHub work history in Jira by running some commands.

Sync and Track your GitHub work with JIRA
Explore the docs »

View Demo · Report Bug · Request Feature

## Table of Contents * [About the Project](#about-the-project) * [Installation](#installation) * [Workflow](#workflow) * [Usage](#usage) * [Contributing](#contributing) * [License](#license) * [Contact](#contact) ## About The Project Jirasync is a CLI tool which collects all GitHub Issues, PR, PR_Reviews and tracks Jira tasks for those. Currently, it is only designed for a single user who syncs his GitHub work history in Jira by running some commands for an interval of a week. #### Main Features - See the list of work was done on GitHub and Redmine based on week and day interval. - Sync and track your own github work in Jira running one command - You can sync not only single user but also multiteam menmbers by configurating team.yaml - All pr_create, pr_reviews, issue_create has been added to sync with JIRA. ## Installation After install, make sure to run `jirasync set-config` successfully to set configuration. #### From source $ git clone https://github.com/omkarkhatavkar/jirasync.git $ cd jirasync/ $ chmod +x setup.sh $ source ./setup.sh ## Workflow #### GitHub Issue WorkFlow - If any new issue created by you in GitHub then is created in the JIRA backlog, by default is assigned to the same user in Jira so he can assign to correct user later. - If the issue is not new and if it is closed then the status is automatically updated.  Case1: Creating new GitHub issues to Jira  Case2: Issues status is automatically updated once issue closed in GitHub ## PR WorkFlow: - If any new PR created by you in GitHub then new task created in the JIRA for Current Sprint, by default is assigned to the same user in Jira. - Once Github PR gets merged then the same Jira Task will be moved to ‘Done’ status.  Case3: Auto PR Create/Closed (Done) manage by Jirasync #### PR_Review WorkFlow: - If you review PR and approve the PR, then the Jira Task is created for review in the current sprint. - Once reviewed PR get merged then the Jira task will be moved to ‘Done’ status  #### Note: - All Jira tasks are uniquely identified as projectname#pr/pr_review/issue#id. ## Usage #### Commands ```bash (env) [root@okhatavk jirasync]# jirasync --help Usage: jirasync [OPTIONS] COMMAND [ARGS]... This CLI tool to sync and track GitHub issues, pr's, pr_reviews with Jira. Currently supported to only for create, update and close status. Options: --debug / --no-debug --help Show this message and exit. Commands: check-github-history see github work history result based on intervals... set-config Set configuration in jirasync before start using it show-team-history see github work history for a team based on... start-syncing sync github issues, pr, pr_reviews as jira tasks for... start-syncing-team sync github issues, pr, pr_reviews as jira tasks for... ``` #### Basic usage Set Configuration: This is the first step, where you can setup your jirasync. ```bash # jirasync set-config --help Usage: jirasync set-config [OPTIONS] Set configuration in jirasync before start using it Options: --git-urls TEXT Pass the git project names for Jira sync e.g. airgun, robottelo --jira-url TEXT Pass the Jira url --github-username TEXT Pass GitHub username --github-token TEXT Pass GitHub token --jira-username TEXT Pass Jira username --jira-email-id TEXT Pass Jira Email Id --jira-board TEXT Pass the Jira board name --jira-project TEXT Pass the Jira project name --help Show this message and exit. ``` Start-Syncing: Sync github issues, pr, pr_reviews as jira tasks for individual user. ``` bash (env) [root@okhatavk jirasync]# jirasync start-syncing --help Usage: jirasync start-syncing [OPTIONS] sync github issues, pr, pr_reviews as jira tasks for individual user. currently supported day and week interval e.g. jirasync start-syncing --interval week Options: --interval TEXT please pass interval e.g. week, day --help Show this message and exit. ``` Start-Syncing: Sync github issues, pr, pr_reviews as jira tasks for whole team. Before that make sure that team.yaml should exist with correct data (for format use team_sample.yaml) ```bash (env) [root@okhatavk jirasync]# jirasync start-syncing-team --help Usage: jirasync start-syncing-team [OPTIONS] sync github issues, pr, pr_reviews as jira tasks for whole team. currently supported day and week interval for all users mentioned in team.yaml e.g. jirasync start-syncing-team --interval week Options: --interval TEXT please pass interval e.g. week, day --help Show this message and exit. ``` ## Contributing #### Bug Reports & Feature Requests Please use the [issue tracker](https://github.com/omkarkhatavkar/jirasync/issues) to report any bugs or file feature requests. #### Developing PRs are welcome. To begin developing, do this: ```bash $ git https://github.com/omkarkhatavkar/jirasync.git $ cd jirasync $ chmod +x setup.sh $ source ./setup.sh ``` ## License Distributed under the MIT License. See `LICENSE` for more information. ## Contact Project Link: [https://github.com/omkarkhatavkar/jirasync](https://github.com/omkarkhatavkar/jirasync)