doc: overhaul RELEASE.md and add generate-release-changelog-links exe#6585
Open
disassembler wants to merge 5 commits into
Open
doc: overhaul RELEASE.md and add generate-release-changelog-links exe#6585disassembler wants to merge 5 commits into
disassembler wants to merge 5 commits into
Conversation
- Rewrites RELEASE.md to reflect the actual release process: Intersect ownership, named sign-offs with two-stage pre-release/full-release gate (SRE now required for pre-release), component team table, honest 4-8 week cadence, dedicated testing section (continuous vs final integration vs performance), and updated versioning notes (no -pre tag suffix, GitHub release type determines pre/full status). - Adds Ensurable Systems alongside IOG and Tweag as contributing organisations. - Converts scripts/generate-release-changelog-links.hs from a cabal script into a proper cabal executable package so nix devshell users get a generate-release-changelog-links binary without running the script manually. - Wires the new exe into the devshell via nix/haskell.nix nativeBuildInputs. - Updates nix build instructions from plan-nix.json to plan-nix, noting result-json as the extra output. - Wraps RELEASE.md prose to 80 columns.
The explicit optparse-applicative ^>= 0.18 dep (and matching import) was blocking resolution with GHC versions that ship optparse-applicative 0.19. All argument parsing goes through turtle, so optparse-applicative is a transitive dep only — removing the explicit bound and the unused Options.Applicative import fixes the solver failure without any code changes. ansi-wl-pprint removed for the same reason: never imported, was only there as a vestige of optparse-applicative 0.18's internal Doc type.
4ae512c to
18e243e
Compare
turtle ^>= 1.6.x requires optparse-applicative < 0.19, conflicting with the rest of the project. allow-newer would satisfy the solver but turtle 1.6.x fails to compile against 0.19 because of the breaking Doc type change (ansi-wl-pprint -> prettyprinter). Replace turtle usage with standard IO: - Shell monad -> plain list IO with mapM/concat - options/optPath/argPath/argText -> execParser/strOption/argument directly - Pattern URL parser -> Text.breakOn/stripPrefix in Maybe monad - printf/format -> Text concatenation and hPutStrLn stderr - die -> exitFailure helper Also drops foldl and prettyprinter which were only needed via turtle.
18e243e to
3aafab6
Compare
carbolymer
reviewed
Jun 1, 2026
carbolymer
reviewed
Jun 1, 2026
carbolymer
approved these changes
Jun 1, 2026
carbolymer
left a comment
Contributor
There was a problem hiding this comment.
👍🏻 for nixifying the script
carbolymer
reviewed
Jun 1, 2026
| scriv | ||
| stylish-haskell | ||
| ] ++ [ | ||
| config.hsPkgs.generate-release-changelog-links.components.exes.generate-release-changelog-links |
Contributor
There was a problem hiding this comment.
this should be added to hydraJobs, to provide caching
Contributor
Author
There was a problem hiding this comment.
it's implicitly there already: https://ci.iog.io/build/13141104#tabs-constituents
…inks - Fold exe into existing nativeBuildInputs list (remove separate ++ []) - Add -O2 -flate-specialise -split-sections -optl-s for smaller/faster binary - Set RTS opts to -A64m -I0 to delay GC for one-shot usage
e228cae to
eec4983
Compare
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.
Description
Add your description here, if it fixes a particular issue please provide a
link
to the issue.
Checklist
See Running tests for more details
CHANGELOG.mdfor affected package.cabalfiles are updatedhlint. See.github/workflows/check-hlint.ymlto get thehlintversionstylish-haskell. See.github/workflows/stylish-haskell.ymlto get thestylish-haskellversionghc-9.6andghc-9.12Note on CI
If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.