ICU-20553 Updating commit checker docs; makes --rev-range required.

This commit is contained in:
Shane Carr 2019-04-08 18:26:02 -07:00 committed by Shane F. Carr
parent 1c553b9cf2
commit 650cccc370
2 changed files with 8 additions and 11 deletions

View file

@ -30,17 +30,13 @@ This is required if you want to process sensitive tickets.
Make sure you have updated your repository:
$ git checkout master
$ git pull upstream master
$ git fetch --tags upstream
Sanity check: ensure that the "latest" tag is correct (points to the latest release). You may need to force-fetch the tags.
Run the tool and save the result into REPORT.md; set fixVersion to the upcoming ICU version, and take the revision range between the previous release and the tip for the upcoming release:
$ git show latest
# should show a commit with both "latest" and the previous version number
Run the tool and save the result into REPORT.md; set fixVersion to the *upcoming* ICU version:
$ pipenv run python3 check.py --jira-query "project=ICU AND fixVersion=64.1" > REPORT.md
$ pipenv run python3 check.py \
--jira-query "project=ICU AND fixVersion=64.1" \
--rev-range "release-63-1..upstream/maint/maint-64"
> REPORT.md
Create a branch and open a pull request so others can view the report easily.

View file

@ -32,8 +32,8 @@ flag_parser = argparse.ArgumentParser(
)
flag_parser.add_argument(
"--rev-range",
help = "A git revision range; see https://git-scm.com/docs/gitrevisions",
default = "latest..master"
help = "A git revision range; see https://git-scm.com/docs/gitrevisions. Should be the two-dot range between the previous release and the current tip.",
required = True
)
flag_parser.add_argument(
"--jira-hostname",
@ -183,6 +183,7 @@ def main():
print("Environment:")
print("- Latest Commit: %s" % commits[0].commit.hexsha)
print("- Jira Query: %s" % args.jira_query)
print("- Rev Range: %s" % args.rev_range)
print("- Authenticated: %s" % "Yes" if authenticated else "No (sensitive tickets not shown)")
print()
print("## Problem Categories")