Name the leg that reads the shell, in the audit that says nothing does - #173
Merged
Conversation
The header of the workflow audit tells a reader what that audit does not reach. It counted the tracked shell scripts and said no analyser for their language is configured anywhere in this tree. A check that reads exactly that language landed on main and this header did not move with it, so somebody opening the workflow that audits the workflows read that the shell here is unanalysed and closed the file wrong about the gate they were checking. The count is gone rather than corrected, because the next script to land would break it again. The sentence about the absence names the workflow that ended it, and what of that issue is still open is stated so the pointer does not read as closed either. Closes #172 Signed-off-by: Nils Lehnen <30603423+iderex@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The issue this belongs to
Closes #172.
What changed
The header of
.github/workflows/zizmor.ymlstops counting the tracked shellscripts and stops saying that no analyser for their language is configured here.
It names
.github/workflows/shell-analysis.ymlas the leg that reads them, sayswhy that is a separate leg rather than a setting inside this one, and says which
halves of #81 are still open so the pointer does not read as closed either.
The count is removed rather than corrected. The next script to land would break a
corrected number in exactly the same way, and a header comment cannot carry the
command that would derive it.
The means is prose in the file that carries the claim. What is wrong is what a
comment asserts, and no check in this tree reads a claim in a workflow comment, so
there was nothing else available.
What failure it prevents
Somebody opening the workflow that audits the workflows, to find out what the gate
does and does not read, is told that the shell in this repository is unanalysed.
They close the file wrong about the gate they were checking, and the sentence
misleads precisely the reader who came to it for coverage.
Evidence
The two sentences, at the commit this branch is cut from:
Three scripts rather than two:
An analyser for their language is configured, and it ran on the head of the
default branch:
The condition in #172 is that both of these answer with nothing. On this branch:
What a guard here refuses, and the proof it bites
No guard is added, and none exists for this class. The check for a named path that
does not resolve reads markdown only, so prose inside a workflow file is outside
what it looks at:
Nothing refused the sentence that went wrong and nothing would refuse the next
one. Removing the count rather than correcting it is the whole of the mitigation.
What this does not cover
NOT COVERED: the rest of that header. The persona argument, the severity setting
and the rule for future workflow changes are untouched.
NOT COVERED: the same shape anywhere else. This change reads one file. A claim
written into another workflow comment is unaffected, and nothing here searches for
one.
NOT ADDED: no mechanism. #172 asks for the sentences to be true, not for a check
that would refuse the next false one.
NOT CLOSED: #81. The header now says which of its halves are still open, and this
change moves neither of them.
Who has read it
Nobody but me. There is no second reader on this board tonight, and the commands
above and the checks on this pull request stand in place of one rather than the
question being left open.