Add release checklists (#106)

Author: straight-shoota

processes/crystal-CHANGELOG.md

@@ -0,0 +1,66 @@
+- **(breaking-change)**
+- **(deprecate)**
+- Fixed ... ([#PR], thanks @author)
+- Fixed docs ...
+- Add ...
+- **(performance)**
+- Add docs ...
+- Refactor ...
+- Fix specs ...
+
+## Language changes
+
+### Macros
+
+## Standard library
+
+### Macros
+
+### Numeric
+<!-- Int, Float, BigInt, ... -->
+
+### Text
+<!-- String, Regex, ...  -->
+
+### Collections
+<!-- Array, Hash, Enumerable, ... -->
+
+### Serialization
+<!-- YAML, JSON, ... -->
+
+### Time
+
+### Files
+
+### Networking
+<!-- HTTP, Sockets, SSL, IO -->
+
+### Logging
+
+### Crypto
+
+### Concurrency
+
+### System
+
+### Runtime
+
+### Spec
+
+## Compiler
+<!-- CLI -->
+
+### Language semantics
+<!-- Codegen issues affecting semantic -->
+
+### Debugger
+
+## Tools
+
+### Formatter
+
+### Doc generator
+
+### Playground
+
+## Others

processes/crystal-release.md

@@ -0,0 +1,103 @@
+# Crystal release process checklist
+
+1. Submit a Freeze/Release PR
+   * 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.
+2. Verify Maintenance CI in the parent commit of the changelog succeed
+   * This mean either the commit was the one used for nightly build or,
+   * A branch with `release/` prefix or `ci` word was pushed
+3. Check the artifacts pass the ecosystem test
+   * Grab latest copy of https://github.com/crystal-lang/test-ecosystem
+   * Override branches of projects if needed at ./scripts/10-clone-repos.sh
+   * Set `./crystal-versions.env` with the URL of the artifacts and with the docker image
+   * Use the different make targets described in the `./README`
+4. Merge the Changelog PR
+5. Tag & annotate the commit with the changelog using `<M.m.p>` pattern as {version} (as a pre-release directly in GH?)
+6. Wait for the build
+7. Smoke test with test-ecosystem
+8. Push changes to OBS for building linux packages
+   1. Checkout https://github.com/crystal-lang/distribution-scripts
+   2. Grab the urls (or local path) of the artifacts from circle-ci
+      * `crystal-*-linux-x86_64.tar.gz`
+      * `crystal-*-linux-i686.tar.gz`
+      * `crystal-*-docs.tar.gz`
+   3. Follow [./packages/README.md](../packages/README.md) in distribution-scripts
+      1. The following steps should run in an openSUSE distribution with osc installed (https://github.com/crystal-lang/osc-docker)
+      1. Configure build.opensuse.org credentials in ~/.oscrc
+      1. `osc branchco devel:languages:crystal crystal`
+      1. `cd home\:$OBS_USERNAME\:branches\:devel\:languages\:crystal/crystal`
+      1. Copy the updated build artifact tarballs in place
+      1. Update version in package specifications:
+         ```bash
+         VERSION=1.1.0 # or whatever version you’re releasing
+         sed -i -e "s/^Version: .*/Version: ${VERSION}-1/" *.dsc
+         sed -i -e "s/^Version: .*/Version: ${VERSION}/" *.spec
+         ```
+      1. Verify the changes with `osc diff`
+      1. Update changelog: `osc vc -m “Update devel:languages:crystal to $VERSION`
+      1. Commit changes: `osc commit -m “Update devel:languages:crystal to $VERSION`
+      1. Now OBS builds the packages. It’s best to continue in the browser now: https://build.opensuse.org/project/show/home:$OBS_USER:branches:devel:langauges:crystal/crystal
+      1. Wait for all jobs to finish and 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)
+9. Build and publish docker images
+   1. Checkout https://github.com/crystal-lang/crystal-dist
+   2. `$ ./dist.sh build-docker {version}`
+   3. `$ ./dist.sh push-docker {version}`
+   4. Manually push the `crystallang/crystal:{version}` image as `crystallang/crystal:latest`
+      * `$ docker tag crystallang/crystal:{version} crystallang/crystal:latest`
+      * `$ docker push crystallang/crystal:latest`
+   5. Manually build and push alpine images
+      * Go to distribution-scripts/docker
+      * `$ make clean alpine DOCKER_REPOSITORY=crystallang/crystal DOCKER_TAG={version} CRYSTAL_VERSION={version} CRYSTAL_TARGZ=~/Downloads/crystal-{version}-1-linux-x86_64.tar.gz`
+      * `$ docker push crystallang/crystal:{version}-alpine`
+      * `$ docker push crystallang/crystal:{version}-alpine-build`
+      * `$ docker tag crystallang/crystal:{version}-alpine crystallang/crystal:latest-alpine`
+      * `$ docker push crystallang/crystal:latest-alpine`
+10. Publish docs
+    1. Have s3cmd installed and AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY env variables defined
+    1. `$ source /Volumes/Secured/secure/manas-aws-key-crystal-dist.sh`
+    1. Checkout https://github.com/crystal-lang/crystal-dist
+    1. Download `*-docs.tar.gz` from circle-ci artifacts
+    1. `$ ./dist.sh push-docs {version} path/to/crystal-{version}-docs.tar.gz`
+    1. `$ ./dist.sh update-docs-versions {crystal_working_copy}`
+    1. `$ ./dist.sh redirect-docs {version}`
+11. Publish snap package
+    1. You need to logged in via `$ snapcraft login`
+    1. Recent tagged release is published directly to edge channel. The CI logs the snap revision number. Otherwise the .snap file is in the artifacts.
+    1. Check the current status to find the revision of the tagged release otherwise:
+    1. `$ snapcraft status crystal`
+    1. `$ snapcraft release crystal <revision-number> beta`
+    1. `$ snapcraft release crystal <revision-number> stable`
+12. Build Github release
+    1. Copy the changelog as release notes in the tag (if not done before)
+    1. Upload the signed binaries, *.tar.gz and *.pkg artifacts
+    1. Signed binaries are in bintray/build/signed
+    1. Publish the Github release
+13. 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).
+    1. Try locally `$ brew install --build-from-source <source of formula>`
+    1. Create PR
+14. Update crystal-website
+    1. Post a release notes in the website
+    1. Update information of `latest_release` in https://github.com/crystal-lang/crystal-website/blob/master/_config.yml
+    1. Update link to blog in https://github.com/crystal-lang/crystal-website/blob/5905e5644fcb4863976d0ca69856edbd74091370/index.html#L26
+15. Post announcement in https://forum.crystal-lang.org/c/news/official
+16. Tweet about the release
+17. Post in Reddit
+18. Update crystal repo to use released version
+   * 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>`
+19. Increment VERSION file to the next minor and -dev suffix
+20. Perform uncomment/todos left in the repo
+21. Update carc.in / play.crystal-lang.org (by jhass)
+    Note: This is done after Arch repos are updated
+
+## Observable Helper
+
+Build changelog lines
+https://observablehq.com/d/035be530d554ccdf
+
+Check commit history
+https://observablehq.com/d/4937e5db876fe1d4

processes/shards-release.md

@@ -0,0 +1,16 @@
+# Shards release process checklist
+
+1. Submit a Release PR
+   * Should contain updates to CHANGELOG, VERSION, shard.yml
+   * Should contain updates to the man files with the release date
+    `$ make clean docs SOURCE_DATE_EPOCH=$(gdate -d "YYYY-MM-DD" +"%s")` if it’s done ahead of time
+2. Merge the Changelog PR
+3. Tag & annotate the commit with the changelog using `v<M.m.p>` pattern as {version}
+   * `git tag -s vX.X.X`
+   * `git push --tags`
+4. Build Github release
+   * Copy the changelog as release notes in the tag
+5. Update distribution-scripts
+   * [linux/Makefile](../linux/Makefile)
+   * [omnibus/config/software/shards.rb](../omnibus/config/software/shards.rb)
+6. Submit a PR to update the homebrew formula in https://github.com/Homebrew/homebrew-core/blob/master/Formula/crystal.rb . Or do it on Crystal release.