chore: ignore local audit output, keep audit-prompt.md tracked#71
Merged
Conversation
The security-audit workflow generates report files under audit/ that are local working artifacts and should not be version-controlled. Add a negated gitignore rule so everything in audit/ is ignored except audit-prompt.md (the reusable prompt), which is committed so the audit can be re-run.
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.
What
Add a negated
.gitignorerule so generated security-audit reports underaudit/stay out of version control, while the reusableaudit/audit-prompt.mdremains committable:Also commits
audit/audit-prompt.mditself so the audit can be re-run by anyone who clones the repo.Why
Running the audit prompt produces a set of report files (
repository-overview.md,authentication.md,marten.md,scorecard.md,executive-summary.md, etc.) that are local working artifacts, not source. They should not be tracked, but the prompt that generates them is worth keeping.Reviewer notes
git check-ignoreignores the generated reports;git add --dry-run audit/stages onlyaudit/audit-prompt.md.