Skip to content

Commit eb94a63

Browse files
committed
docs(agents): enforce tag->draft->publish release sequence
1 parent 2a6a06c commit eb94a63

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,23 @@ Targeted test suites (when working on specific areas):
4242
- `**Full Changelog**: https://github.com/MagnusOpera/FScript/compare/<previous-tag>...<new-tag>`
4343
- When publishing the GitHub release, include that same compare link in the release notes body.
4444

45+
## Release Process (Tags and GitHub Draft)
46+
47+
Follow this exact sequence for every release:
48+
49+
1. Move `## [Unreleased]` entries to `## [X.Y.Z]` in `CHANGELOG.md`.
50+
2. Add/verify compare link in that version section.
51+
3. Commit the changelog update to `main`.
52+
4. Create and push tag `X.Y.Z`.
53+
5. Wait for CI to create the GitHub Release **as draft** from the tag workflow.
54+
6. Only after the draft exists, update draft notes from `CHANGELOG.md` if needed.
55+
7. Publish that existing draft release (do not create/publish a release manually before CI draft creation).
56+
57+
Rules:
58+
- Tag-triggered CI is the source of truth for release artifacts and draft release creation.
59+
- Do not bypass the draft step.
60+
- Release notes must match the `CHANGELOG.md` version section and keep the compare link.
61+
4562
## Specification Maintenance (Mandatory)
4663

4764
- Any behavioral change in language, runtime, hosting, sandbox, or LSP must update the corresponding spec in `docs/specs/`.

0 commit comments

Comments
 (0)