docs: adopt scriv changelogs across the ecosystem (ADR 0009)#6
Merged
Conversation
Records the ecosystem-wide decision to keep changelogs with scriv, reversing the no-changelog clause of ADR 0006: - ADR 0009 (the new record), an ADR 0006 status note, and the ADR index entry. - CONTRIBUTING gains a Changelogs section and a scriv collect step in the release flow. - The set's own scriv-managed CHANGELOG.md, backfilled with the psc-* releases, plus changelog.d/scriv.ini. scriv for this repo comes from the pslua dev shell. Part of purescript-lua/purescript-lua#101 (ecosystem-wide changelogs).
There was a problem hiding this comment.
Pull request overview
This PR updates the package-set ecosystem documentation to adopt scriv-managed changelogs (per new ADR 0009), addressing the discoverability gap created by the recent high-volume fork/FFI work where release notes were otherwise only aggregated in package-set bump commits.
Changes:
- Adds ADR 0009 documenting the decision to manage
CHANGELOG.mdvia scriv across the ecosystem, and indexes it in the ADR README. - Updates ADR 0006 status notes to reflect the changelog decision as a superseded clause.
- Introduces a scriv-managed root
CHANGELOG.mdfor this repository pluschangelog.d/scriv.ini, and updates CONTRIBUTING with the new changelog + release steps.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/adr/README.md | Adds ADR 0009 to the ADR index. |
| docs/adr/0009-changelogs-via-scriv.md | New ADR defining scriv-based changelog policy and release workflow implications. |
| docs/adr/0006-fork-release-by-annotated-tag.md | Notes that ADR 0006’s no-changelog clause is superseded by ADR 0009. |
| CONTRIBUTING.md | Documents scriv fragment workflow and adds scriv collect to the release process. |
| CHANGELOG.md | Adds a scriv-managed changelog seeded/backfilled with recent psc-* set releases. |
| changelog.d/scriv.ini | Adds scriv configuration for Markdown changelog collection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
docs: adopt scriv changelogs across the ecosystem (ADR 0009)
The pre-release FFI campaign (purescript#73-purescript#102) flipped the tradeoff that ADR 0006 made: the fork tags carry one line each, and the only place those lines are aggregated is this repo's set-bump commit messages. A consumer pinning numbers v9.1.3 has no way to read what moved since v9.1.0 without walking two git logs. So the whole ecosystem moves to a managed changelog.
What
CHANGELOG.mdmanaged with scriv. It supersedes only the no-changelog clause of ADR 0006; the rest of the tag-driven release flow stands. ADR 0006's status notes the supersession and the index lists 0009.src/change) and ascriv collect --version <tag>step at the front of the release flow.CHANGELOG.md, backfilled with thepsc-*set releases (the FFI campaign window and the new-spago migration), pluschangelog.d/scriv.ini. The set has no flake, so itsscrivcomes from the pslua dev shell.This is the canon half of purescript-lua/purescript-lua#101. The forks carry the matching scaffold in their own repos.