Crystal release 1.2.2

[straight-shoota]

Release preparation

1. Announce expected release date and time span for feature freeze
   • Feature freeze is about two weeks before release
2. Start preparing changelog and release post
3. Start feature freeze period
   • Either no merging of features into master or split off release branch for backporting bugfixes.
4. Publish release PR draft (Release 1.2.2 crystal#11391)
   • It should contain the expected date of the release (~two weeks after the PR is issued).
   • It should be populated with updates to CHANGELOG.md and VERSION.

Release process

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. Tag & annotate the commit with the changelog using <M.m.p> pattern as {version} (as a pre-release directly in GH?)
7. Publish Github release
   1. Copy the changelog section as description
   2. Binaries are added later

Binary releases

1. Wait for the release build in circle CI
2. Smoke test with test-ecosystem (again)
3. Attach build artifacts to Github release
   • crystal-*-darwin-*.tar.gz
   • crystal-*-linux-*.tar.gz
   • crystal-*.pkg
   • crystal-*-docs.tar.gz
4. Publish 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 CRYSTAL_VERSION=${VERSION} to publish docs to api/${VERSION}
   3. Run make -C docs dist-redirect_latest CRYSTAL_VERSION=${VERSION} to apply redirect from api/latest to api/${VERSION}
5. 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. Run ./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. 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
   5. Verify package installation
      • OBS_PROJECT=home:$OBS_USER:branches:devel:languages:crystal bats test
   6. When everything is green, create a submit request against the original package (Submit package link in the menu bar on the package in your branch)
6. Tag latest docker images
   • Versioned docker images have been pushed to dockerhub.
   • Now just assign the latest tags:
   • $ ./docker/apply-latest-tags.sh {version}
7. Publish snap package
   1. You need to logged in via $ snapcraft login
   2. Recent tagged release is published directly to edge channel. The CI logs the snap revision number. Otherwise the .snap file is in the artifacts.
   3. Check the current status to find the revision of the tagged release otherwise:
   4. $ snapcraft status crystal
   5. $ snapcraft release crystal <revision-number> beta
   6. $ snapcraft release crystal <revision-number> stable
8. Submit a PR to update the homebrew formula in https://github.com/Homebrew/homebrew-core/blob/master/Formula/crystal.rb .
   1. Update the previous and new version (with their respective hashes).
   2. Try locally $ brew install --build-from-source <source of formula>
   3. Create PR (crystal 1.2.2 Homebrew/homebrew-core#89149)

Release announcements

1. Update crystal-website (Release post for 1.2.2 crystal-website#208)
   1. Post a release notes in the website
   2. Update information of latest_release in https://github.com/crystal-lang/crystal-website/blob/master/_config.yml
   3. Update link to blog in https://github.com/crystal-lang/crystal-website/blob/5905e5644fcb4863976d0ca69856edbd74091370/index.html#L26
2. Post announcement in https://forum.crystal-lang.org/c/news/official
3. Tweet about the release
4. Post in Reddit
5. Update https://github.com/crystal-lang/crystal-book/blob/master/crystal-version.txt (https://github.com/crystal-lang/crystal-book/compare/master...straight-shoota:feature/crystal-1.2.2?expand=1)

Post-release

1. Update crystal master branch to use released version (Update previous Crystal release - 1.2.2 crystal#11430)
   • 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/win.yml to point to docker image
   • Edit shell.nix latestCrystalBinary using nix-prefetch-url --unpack <url>
2. Increment VERSION file to the next minor and -dev suffix
3. Perform uncomment/todos left in the repo
4. Update carc.in / play.crystal-lang.org (by jhass)
   Note: This is done after Arch repos are updated