Release Crystal 1.14.0

[straight-shoota]

Release preparation

1. Announce expected release date (2024-10-09) and time span for feature freeze (starting on 2024-09-25)
   • Feature freeze is about two weeks before release
   • Set date on milestone
2. Prepare the changelog entry: crystal:scripts/github-changelog.cr
   • Ensure that all merged PRs are added to the milestone (check is:pr is:merged sort:updated-desc no:milestone).
   • Ensure that all milestoned PRs are properly labelled (check is:pr is:merged sort:updated-desc no:label milestone:1.14.0).
3. Start preparing release notes
4. Start feature freeze period (on 2024-09-25)
   • Either no merging of features into master or split off release branch for backporting bugfixes.
5. Publish release PR draft (Release 1.14.0 crystal-website#843)
   • It should contain the expected date of the release.
   • It should be populated with updates to CHANGELOG.md, src/VERSION and the version in shard.yml.
6. Ensure documentation for language and compiler changes and other relevant changes is up to date.
   • Crystal Book
     • Update language specification
     • Update compiler manual
     • Add or update guides / tutorials?
7. Ensure that test-ecosystem functions and succeeeds on master
   • Run Test Crystal & Shards Workflow

Release process (on 2024-10-09)

Source release

1. Finalize the release PR
   • Make sure all changes are mentioned in the changelog
   • Check release date
   • Un-draft the PR
2. Split off release branch (release/x.y)
3. Verify Maintenance CI workflow succeeds on the HEAD of the release branch
4. Smoke test with test-ecosystem
   • Run Test Crystal & Shards Workflow with the release branch as crystal_branch.
5. Merge the release PR
6. Make the release and publish it on GitHub: ../distribution-scripts/processes/scripts/make-crystal-release.sh (run from crystallang/crystal@$VERSION work tree). This performs these steps:
   1. Tag & annotate the commit with the changelog using <M.m.p> pattern as version
   • git tag -s -a -m $VERSION $VERSION
   • git push --tags
   2. Publish Github release (https://github.com/crystal-lang/crystal/releases/new)
      • Copy the changelog section as description
      • Binaries are added later
7. Close milestone (https://github.com/crystal-lang/crystal/milestones)
8. Wait for the release build in circle CI (https://app.circleci.com/pipelines/github/crystal-lang/crystal)

Binary releases

3. Publish build artifacts from CircleCI and GitHub Actions to GitHub release. For URL_TO_CIRCLECI_ARTIFACT grab the URL
   of any of the build artifacts in circleCI (doesn't matter which).
   • Upload build artifacts from CircleCI: ../distribution-scripts/processes/scripts/publish-crystal-packages-on-github.sh $URL_TO_CIRCLECI_ARTIFACT (run from crystallang/crystal@$VERSION work tree)
     • crystal-*-darwin-*.tar.gz
     • crystal-*-linux-*.tar.gz
     • crystal-*.pkg
     • crystal-*-docs.tar.gz
   • Upload build artifacts from GHA (Windows):
     • crystal-release.zip -> crystal-$VERSION-windows-x86_64-msvc-unsupported.zip
     • crystal-installer.zip -> unzip -> crystal-$VERSION-windows-x86_64-msvc-unsupported.exe
4. Push changes to OBS for building linux packages
   1. Checkout https://github.com/crystal-lang/distribution-scripts and go to ./packages
   2. Configure build.opensuse.org credentials in environment variables:
      • export OBS_USER=
      • export OBS_PASSWORD=
   3. Update the crystal package: ./obs-release.sh devel:languages:crystal crystal $VERSION
      • Uses the docker image crystallang/osc to run the CLI client for OBS.
      • The script creates a branch in you home project, updates the version and pushes it back to OBS.
      • You can also run the commands from that file manually and check build locally with
        • osc build xUbuntu_20.04 x86_64
        • osc build Fedora_Rawhide x86_64
   4. Create the crystal1.14 package: ./obs-new-minor.sh devel:languages:crystal crystal1.14 $VERSION crystal${OLD_VERSION%.*}
   5. Now OBS builds the packages. It’s best to follow the build status in the browser:
      1. open https://build.opensuse.org/project/show/home:$OBS_USER:branches:devel:langauges:crystal/crystal
      2. Wait for all package build jobs to finish and succeed
   6. When everything is green, create a submit request against the original packages (Submit package link in the menu bar on the package in your branch)
   7. Verify package installation
      • OBS_PROJECT=devel:languages:crystal bats test
5. Tag latest docker images
   • Versioned docker images have been pushed to dockerhub.
   • Now just assign the latest tags:
   • ./docker/apply-latest-tags.sh 1.14.0
6. Publish snap package (you can use the docker image snapcore/snapcraft for running the following commands)
   1. docker run --pull=always --rm -it snapcore/snapcraft
   2. You need to logged in via snapcraft login
   3. Recent tagged release is published directly to edge channel. The CI logs the snap revision number. Otherwise the .snap file is in the artifacts.
   4. Check the current status to find the revision of the tagged release otherwise:
   5. snapcraft status crystal
   6. snapcraft release crystal <revision-number> beta
   7. snapcraft release crystal <revision-number> stable
7. Check PR for homebrew: https://github.com/Homebrew/homebrew-core/pulls?q=is%3Apr+crystal+sort%3Aupdated-desc
   • It should've been automatically created

Publish documentation for the release

1. Publish API docs
   1. Have AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY env variables defined
      • Keys can be generated at https://console.aws.amazon.com/iam/home#/security_credentials (contact a Manas admin if you don't have access).
   2. Run make -C docs publish_docs dist-redirect_latest CRYSTAL_VERSION=1.14.0 to publish docs to api/1.14.0 and apply redirect from api/latest to api/1.14.0
2. Publish Crystal book
   1. Create release/1.14 branch and push it to crystal-lang/crystal-book (deployment happens automatically in GHA)
   2. Verify that deployment was successfull

Release announcements

1. Publish release notes on the website
2. Post announcement in https://forum.crystal-lang.org/c/news/official
3. Announce on social media accounts (via Buffer; credentials are in Passbolt) and pin release posts
4. Update https://github.com/crystal-lang/crystal-book/blob/master/crystal-version.txt
5. Post the release in https://opencollective.com/crystal-lang

Post-release

1. Update crystal master branch to use released version: crystal:scripts/release-update.sh 1.14.0
   • Edit PREVIOUS_CRYSTAL_BASE_URL in .circleci/config.yml
   • Edit DOCKER_TEST_PREFIX in bin/ci
   • Edit prepare_build on_osx download package and folder
   • Edit .github/workflows/*.yml to point to docker image
   • Edit shell.nix latestCrystalBinary using nix-prefetch-url --unpack <url>
2. Increment src/VERSION and version in shard.yml to the next minor plus -dev suffix
3. Perform uncomment/todos left in the repo
4. Update default base version in test-ecosystem: test-ecosystem:scripts/release-update.sh 1.14.0
5. Merge release/1.14 branch into master (if the two have diverged)

• This needs to be a merge commit. Those are disabled in the GitHub UI.
• git switch master && git pull && git merge release/1.14; git checkout master src/VERSION && git add src/VERSION && git commit
• Double check merge commit history is as expected
• git push (GitHub branch protection rules normally prevent direct pushes to
  master. This needs to be deactivated for this purpose, which can be on a
  per-user basis.)