This application helps to move the issues on kanban board automatically according to Github pull request activities for the projects which are using Jira to tracking issues.
In our company, we are using Jira to tracking the issues and using Github to manage the sources. We have already integrated Jira with Github with a plugin and we are using a strategy for this integration for branches and commit messages. But, this plugin does not solve all the needs. For example, the issues don't move automatically when somebody creates a pull request for the issues. The issue should be in a specific board column (for example code review) after somebody creates a pull request for the issue. Before this library, we had been doing this actions by ourself, manually. Because, in QA testing side, they don't know Github and source code and code review process. They are using Jira and automatically deployed test environments. And they don't know the real staus of issue if somebody forgot the move the issue on the kanban board.
Basically, we are using Jira API and Github Hooks mechanism to track the issues and pull request actions.
1 - A Jira Account to get api token 2 - Permission to add a hook the repository (on Github only for now). 3 - And a Heroku account (optional)
Step 1: You should know the transition id's of your project flow. So, you should now the next column id of the board after code review finished. Also, there is another id which is using to understand the next state of the issue on the board when the code needs some changes after code review. To learn these ids, we are using this api endpoint.
Step 2: We suggest the Heroku (free one is enough) but you can use other services. You need to deploy the application. You can use Gunicorn to run as a service. Please check the Procfile for more information.
Step 3: After that, you need to create a webhook on github. Follow the below screenshots:
Step 4: We have a .env file and we are using Postgresql to track the relation between Jira and Github. Please copy
the .env.dist file as .env and fill the parameters.
Stem 5: At the end, you need to import sql/dump.sql file to your database.
Now, you are ready.
- Your branch names should be same with your Jira issue id. (For example, you have an issue on Jira as JIRA-1234. You should create a branch directly named as JIRA-1234.)
OR
- Your pr message text must be include jira task id. Both apply.
@suhaboncukcu @hkulekci
You can create an issue if you need any help about the installation part.