Skip to content

ci: generate release fixtures in the release job - #9624

Closed
rasswanth-s wants to merge 1 commit into
rasswanth/migrations-remove-stalefrom
rasswanth/release-fixtures-in-cd
Closed

rasswanth-s wants to merge 1 commit into
rasswanth/migrations-remove-stalefrom
rasswanth/release-fixtures-in-cd

Conversation

@rasswanth-s

Copy link
Copy Markdown
Collaborator

Summary

Every release now writes its release fixtures automatically, so the manual fixture step is gone from the release runbook. A release fixture is a small sample of data exactly as one release wrote it. Later releases' tests load it to prove they still read that data. Stacked on #9623.

Changes

  • The syft, syft-job and syft-dataset release jobs generate the fixture in the "Freeze release artifacts and fixture" step and commit it with the artifacts. It's inside the release tag and reaches dev with the release-branch merge.
  • The generators skip a fixture that already exists, so re-running a failed release job passes.
  • Prettier skips every migrations/p2p/fixtures/ folder, so the merge-back PR doesn't reformat files that CD wrote.
  • docs/release.md and the syft-job README describe the automated step; the manual step is removed.

Testing

  • Ran the three freeze steps as written in a scratch worktree. Run 1 committed the artifacts and fixtures, with the pre-commit hooks passing on those commits. Run 2 changed nothing.
  • With those fixtures in place, the release-fixture tests run instead of skipping, and all migration suites pass.
  • actionlint is clean on the three workflows.

Asana task

PR naming convention

Your PR title must follow this format or merging will be blocked:

type: short description in lowercase

Example titles:

  • feat: add retry logic to job approval
  • fix: handle timeout in notification sender
  • docs: update syft-bg README
  • chore: bump dependencies
  • refactor: split init flow into helpers
  • test: add criteria validation tests
  • ci: add release train workflow

Allowed types:

Type When to use Example
feat New feature or capability feat: add DS rejection emails
fix Bug fix fix: handle empty peer list
docs Documentation only docs: update syft-bg README
chore Maintenance, deps, config chore: bump dependencies
refactor Code restructuring (no behavior change) refactor: split init flow
test Adding or updating tests test: add approval criteria tests
ci CI/CD workflow changes ci: add release train workflow
perf Performance improvement perf: cache Drive API responses
build Build system or dependency changes build: pin syft-bg>=0.2.0

Just edit the PR title to fix any errors — the check re-runs automatically.

Auto-labeling

Labels are applied automatically — you don't need to add them manually:

  • Type labels from your PR title (e.g., feat: adds feature, fix: adds bugfix)
  • Package labels from which files you changed (e.g., editing packages/syft-bg/ adds pkg:syft-bg)

These labels are used to auto-generate categorized release notes.

🤖 Generated with Claude Code

The syft, syft-job and syft-dataset release jobs now write each release's
fixture next to its release artifacts and commit both before the build, so
every release ships the data later releases test against. The generators
skip a fixture that already exists, so a re-run of a failed job passes, and
prettier no longer formats any release fixture.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@rasswanth-s

Copy link
Copy Markdown
Collaborator Author

Parking this as a draft. Per the review on #9623, protocol 0 stays open until 1.0.0, so a release must not write release fixtures yet: a fixture freezes v0 the same way an artifact does. #9623 now removes the freeze steps this PR extends, so this branch also conflicts. It can come back, rebased, when we freeze protocol 0 for 1.0.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant