Automated Releases

[miraclx]

This introduces a CI workflow that automates GitHub releases as well as publishing to crates.io.

How to update versions

• Submit a PR that bumps the version of the Cargo.toml file.
• Ensure the Cargo.lock file is also updated.
• Move all entries under the Unreleased section of the CHANGELOG.md file to a versioned section.
• Once the PR is merged, the release happens!

How it works

Unlike most workflows, this doesn't trigger on a tag push. Instead, the first job in the workflow checks for a version bump to the Cargo.toml file when merged to master.

If a version bump was detected, we check if that version has already been published to crates.io. If it hasn't, we publish the crate. The second part of this, is checking if the tag already exists on GitHub. If it doesn't, we proceed with the release process.

The release process builds binaries for multiple platforms, and makes them available for download from the final release page as archives, including hashes of each archive in the release note, in case users need to verify them. This also tags the contributors that made the release happen, links to the version of the crate on crates.io, and appropriately tags pre-release versions on GitHub.

Now for some cases

• If the version has already been published to crates.io and released to GitHub
• Final release page
• File Hashes
• Pre-release tag

[itegulov]

This is very nice. Feels like it deserves to be its own independent Github Action. @miraclx have you considered this?

Also, the release process is valuable knowledge, so lets put it in some visible place like RELEASE.md.