Skip to content

Stop committing the generated advisory index - #147

Merged
p-linnane merged 1 commit into
mainfrom
drop-committed-advisory-index
Aug 24, 2026
Merged

Stop committing the generated advisory index#147
p-linnane merged 1 commit into
mainfrom
drop-committed-advisory-index

Conversation

@p-linnane

@p-linnane p-linnane commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

The advisory index is built from the reviewed records on main and served at formulae.brew.sh/api/advisories.json, and brew's advisory client reads it there as of 6.0.19 (today's consumer is generate-formula-api), so the committed copy can go. The regeneration PR summary now builds its before/after indexes in memory from the per-record trees, and the advisories:concat rake task remains for local validation.

Copilot AI lite review requested due to automatic review settings August 24, 2026 15:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes the committed generated advisory index while retaining per-record advisories and local generation support.

Changes:

  • Stops staging the generated index in the regeneration workflow.
  • Ignores the generated index locally.
  • Updates documentation and workflow expectations.

A critical issue remains: the workflow鈥檚 summary step still reads the deleted index and will fail during regeneration.

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Summary
spec/workflows_spec.rb Updates workflow expectations.
lib/advisory_index.rb Clarifies local versus production index usage.
CONTRIBUTING.md Documents the production advisory index.
.gitignore Ignores the generated index.
.github/workflows/regenerate.yml Stops staging the index, but its summary step still depends on it.

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/regenerate.yml
The index is built from the reviewed records on main and served by
formulae.brew.sh at /api/advisories.json, where brew's advisory client
reads it as of 6.0.19. Regenerate no longer concatenates or commits
data/advisories.json, and the PR summary builds its before/after
indexes in memory from the per-record trees instead of reading the
committed copy. The advisories:concat rake task remains for local
validation.

Signed-off-by: Patrick Linnane <patrick@linnane.io>
@p-linnane
p-linnane force-pushed the drop-committed-advisory-index branch from ad317be to a6ec2b8 Compare August 24, 2026 15:18
@p-linnane
p-linnane merged commit 3184734 into main Aug 24, 2026
5 checks passed
@p-linnane
p-linnane deleted the drop-committed-advisory-index branch August 24, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants