Skip to content

Commit ec862eb

Browse files
authored
Merge pull request github#16196 from michaelnebel/misc/expected-changes-usageinfo
Print usage information for accept-expected-changes script in case PR…
2 parents 9671e05 + 52be657 commit ec862eb

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

misc/scripts/accept-expected-changes-from-ci.py

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,19 @@ def ok_job_name(job_name: str) -> bool:
431431
print("Expected output in semmle-code changed!")
432432

433433

434+
def printHelp():
435+
print("""Usage:
436+
python3 accept-expected-changes-from-ci.py [PR-number|SHA]
437+
438+
Example invocations:
439+
$ python3 accept-expected-changes-from-ci.py 1234
440+
$ python3 accept-expected-changes-from-ci.py d88a8130386b720de6cac747d1bd2dd527769467
441+
442+
Requirements:
443+
- The 'gh' command line tool must be installed and authenticated.
444+
- The CI check must have finished.
445+
""")
446+
434447
if __name__ == "__main__":
435448

436449
level = logging.INFO
@@ -462,10 +475,16 @@ def ok_job_name(job_name: str) -> bool:
462475
args = parser.parse_args()
463476

464477
if args.posarg is None:
465-
pr_number_response = subprocess.check_output([
466-
"gh", "pr", "view", "--json", "number"
467-
]).decode("utf-8")
468-
pr_number = json.loads(pr_number_response)["number"]
478+
try:
479+
pr_number_response = subprocess.check_output([
480+
"gh", "pr", "view", "--json", "number"
481+
]).decode("utf-8")
482+
pr_number = json.loads(pr_number_response)["number"]
483+
except:
484+
print("Could not auto detect PR number.")
485+
print("")
486+
printHelp()
487+
sys.exit(1)
469488
else:
470489
if len(args.posarg) > 10:
471490
override_sha = args.posarg

0 commit comments

Comments
 (0)