{{ message }}
docs: add a scriv-managed changelog#7
Merged
Merged
Conversation
Adds a CHANGELOG.md managed with scriv (fragments in changelog.d/), provides scriv in the flake dev shell, backfills the v0.1.0 and v0.2.0 releases, and captures the unreleased new-spago migration and scripts/run runner as a pending fragment. The AGENTS.md Releasing note now points at the scriv flow. Part of the ecosystem-wide changelog adoption (purescript-lua/purescript-lua#101); canon in package-set ADR 0009.
There was a problem hiding this comment.
Pull request overview
Adds a Scriv-managed changelog workflow to align purescript-lua-ngx with the broader ecosystem: a new CHANGELOG.md seeded with historical releases, Scriv configuration + an initial fragment, and updated release guidance in AGENTS.md.
Changes:
- Add
CHANGELOG.mdwith Scriv markers and backfilled entries for v0.1.0 and v0.2.0. - Introduce Scriv config (
changelog.d/scriv.ini) and a pending fragment (changelog.d/0001-...). - Update
AGENTS.mdrelease process to include writing fragments and runningscriv collect.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Addresses Copilot review on PR #7: the Releasing note inherited the fork template's `master`, but ngx's default branch is `main`.
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: add a scriv-managed changelog
Brings ngx in line with the rest of the ecosystem: a
CHANGELOG.mdmanaged with scriv,scrivin the flake dev shell, and anAGENTS.mdrelease note that points at the scriv flow.What
CHANGELOG.mdwith the scriv markers, backfilling v0.1.0 (the initial OpenResty bindings) and v0.2.0 (the toolchain refresh).changelog.d/scriv.iniconfig, plusscrivin the dev shell.scripts/runOpenResty runner. It folds into the next release when someone runsscriv collect.AGENTS.md"Releasing" section now says to write a fragment and runscriv collect, instead of "no changelog entry".Nothing under
src/changed, so this needs no tag or set bump.Part of purescript-lua/purescript-lua#101. The reasoning is in package-set ADR 0009.