Keep an unrecognised status inside its code span
`status_phrase` renders a status it does not know verbatim, deliberately:
`argparse`'s `choices=` would exit 2 on an unexpected value and the log --
the entire reason this script exists -- would never be posted.
But the verbatim value lands in a code span inside a **bold** header, so a
backtick in it closes the span early and the rest renders as markdown:
--status 'x` **loud** `y'
-> **`tests` finished with status `x` **loud** `y`**
Nothing hostile is expected: the value comes from `${{ job.status }}` or a
hand-written flag, both written by whoever wrote the workflow. It is worth
closing anyway because this repo is public and four others consume the
script as a composite action, so a branch name or a matrix value could
reach this argument later without anyone revisiting this function.
Backticks are removed rather than escaped -- there is no escape for a
backtick inside a code span, only a wider fence, and the status is a short
word rather than something whose exact bytes matter.
Found in the cold re-read of #10, not by the suite, so the test that
covers it was proved to fail without the fix.
Co-authored-by: bit <bit@das-labor.org>
This commit is contained in:
@@ -82,7 +82,13 @@ def status_phrase(status):
|
||||
key = DEFAULT_STATUS
|
||||
if key in STATUS_PHRASES:
|
||||
return STATUS_PHRASES[key]
|
||||
return "finished with status `" + status.strip() + "`"
|
||||
# Backticks removed, not escaped: the verbatim value goes inside a code
|
||||
# span in a **bold** header, and a backtick in it closes the span early --
|
||||
# the rest of the status then renders as markdown. Nothing hostile is
|
||||
# expected here (`${{ job.status }}` is written by whoever wrote the
|
||||
# workflow), but this repo is public and consumed by four others, and a
|
||||
# branch name or matrix value could reach this argument later.
|
||||
return "finished with status `" + status.strip().replace("`", "") + "`"
|
||||
|
||||
|
||||
def missing_log_note(path, phrase):
|
||||
|
||||
Reference in New Issue
Block a user