docs: list TRUSTABL_FINDINGS_COUNT among the trustabl.env outputs - #30
Open
bradAGI wants to merge 1 commit into
Open
docs: list TRUSTABL_FINDINGS_COUNT among the trustabl.env outputs#30bradAGI wants to merge 1 commit into
bradAGI wants to merge 1 commit into
Conversation
The scanner writes five variables; the evaluation guide names four. scan/trustabl-scan.sh:161 TRUSTABL_EXIT_CODE scan/trustabl-scan.sh:162 TRUSTABL_READINESS_SCORE scan/trustabl-scan.sh:163 TRUSTABL_RISK_SCORE scan/trustabl-scan.sh:164 TRUSTABL_MAX_SEVERITY scan/trustabl-scan.sh:165 TRUSTABL_FINDINGS_COUNT <- undocumented here The root README's Outputs section already lists all five, so the guide was the one out of step. Findings count is also the variable a downstream step is most likely to reach for — a badge, a Slack line, a Security Hub import — since the other four describe the gate rather than what it found.
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
1 participant
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 scanner writes five variables to
trustabl.env;docs/EVALUATION.mdnames four.vs the guide:
The root README's Outputs section already lists all five, so the guide is the one out of step.
Worth fixing rather than leaving: findings count is the variable a downstream step is most likely to want — a badge, a Slack summary, a Security Hub import — because the other four describe the gate's decision rather than what was actually found. Someone reading only the evaluation guide would not know it is there.
One-line docs change.