AuroraMiddleware/scuffed-code
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
d60ebc020e
scuffed-code/tools/commit-checker/README.md
Shane Carr d60ebc020e ICU-20166 Adding commit-checker tool. 
This tool checks the integrity of a range of commits, in particular references to the corresponding Jira issues.

Squashed commits:

ICU-20119 Adding first commit report.
ICU-20166 Handling tickets that do not require commits.
ICU-20166 Search Jira issues from extra commits
ICU-20119 Updating commit report.
ICU-20166 Adding copyright to commit checker tools.
ICU-20119 Updating commit report.
ICU-20166 Require ticket at beginning of commit message.
ICU-20119 Updating commit report.
ICU-20119 Updating commit report.
ICU-20119 Updating commit report.
ICU-20120 Updating commit report.
ICU-20166 Removing REPORT.md from source control.
2018-10-17 15:58:40 -05:00

858 B
Raw Blame History

Commit Checker Tool

This tool checks the ICU Git repository against the ICU Jira issue tracker to ensure that the two are consistent with one another.

Author: Shane Carr

Installation

Install pipenv globally:

$ sudo pip3 install pipenv

Install this project's dependencies locally:

$ pipenv install

Optional: save your Jira credentials in a .env file in this directory:

JIRA_USERNAME=hello
JIRA_PASSWORD=world

This is required if you want to process sensitive tickets.

Usage

Make sure you have updated your repository:

$ git pull upstream master

Run the tool and save the result into REPORT.md:

$ pipenv run python3 check.py > REPORT.md

Open a pull request so others can view the report easilly.