Prepare release 1.1

Open
#2,467 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, haskell

Research direction

Read the release checklist in this issue, then inspect MAINTAINERS.md, CHANGELOG.md, MODULE.bazel files, the start script, haskell/private/versions.bzl, and the Prepare Release workflow. Review changes since the previous release and follow the listed checks; done means the release branch and PR are merged, the release is published, and the deployed start script is current.

Written by the indexing model from the issue text.

Description

  • Read through this process in its entirety so you understand it.
  • Create and checkout a new release preparation branch, named
    release-<major>.<minor>.
  • If the minimal Bazel version has changed:
  • Remove any feature that is still too experimental to go into a
    release, by cherry-picking reverts (or by manually deleting the
    feature).
    • Check the list here
      for PRs that have been explicitly marked for removal, if any.
  • Amend the CHANGELOG by summarising all significant
    pull requests since the last release (see
    here). Specifically:
    • Add a "Highlights" section for major improvements/changes.
    • Create "Added", "Removed", "Changed" and "Fixed" sections, as
      necessary.
    • If relevant, add links to the corresponding PRs to the entries.
  • Update the version of the modules in MODULE.bazel files
  • Push the release-<major>.<minor> branch and open a PR; go through review and merge upon success.
  • Trigger the Prepare Release workflow
    • either via the Github UI or
    • run gh workflow run -f version=<major>.<minor> 'Prepare Release' using the Github CLI
  • Go to the releases, open the draft release which was created to inspect it
    • Do the code snippets look valid?
    • Is there a release artifact attached to it?
    • If you're happy, publish the release... 🚀
  • After the "Publish" workflow is finished check whether https://haskell.build/start
    is now the latest start script (Netlify sometimes has problems).
  • Announce the new version on Twitter by asking someone with access.
Dominant language
Starlark
Stars
279
Forks
94
Avg merge
1d 12h
Merged PRs (30d)
10

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tweag/rules_haskell

All issues in tweag/rules_haskell

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.