Skip to content

RELEASE.md

Latest commit

 

History

History
34 lines (26 loc) · 1.9 KB

RELEASE.md

File metadata and controls

34 lines (26 loc) · 1.9 KB
Raw

Release checklist

Glistix checklist

Additional instructions for Glistix:

  1. Ensure compiler-core/src/version.rs and README.md both report the current Gleam version we're tracking.
  2. Bump Glistix version in each Cargo.toml (as well as Cargo.lock by running cargo check once), in the new project flake template at compiler-cli/src/new.rs (which will require updating test snapshots at compiler-cli/src/new/snapshots) and in nix/glistix.nix, as well as in README.md.
  3. Update the cargoHash in nix/glistix.nix by setting it to "" and trying to run nix build. The error will inform the new hash.
  4. Follow "Gleam checklist" below.
  5. Add changelog to the Glistix book (initially with "(Unreleased)" as the release date).
  6. Update the book as needed (there are several compiler internals documented there, including which patches we applied on top of the base Gleam compiler).
  7. Update the Glistix version in the book's installation instructions in "Getting Started".
  8. Ensure the Zulip invite is up-to-date in the README and book (if present).
  9. If the default gleam.toml changed, update it in the book's "Project configuration" section.

After release:

  1. Update the new version's changelog in the book to display the release date in UTC (both in the changelog's page and in the src/SUMMARY.md).
  2. Push a book tag with the new release version.
  3. Bump the Glistix playground's Glistix version by updating the GLEAM_VERSION file.
  4. Update Glistix library forks' flakes to point to the new Glistix version.

Gleam checklist

  1. Update the version in each Cargo.toml.
  2. Update versions in src/new.rs for stdlib etc if required.
  3. Run make test build.
  4. Git commit, tag, push, push tags.
  5. Wait for CI release build to finish.
  6. Publish release on GitHub from draft made by CI.
  7. Update version in Cargo.toml to next-dev.
  8. Update clone target version in getting-started.md in website.