From ce2246bcfdcbce2e2ef30ec44fbfae26d3914139 Mon Sep 17 00:00:00 2001 From: orhun Date: Tue, 29 Jun 2021 20:45:09 +0300 Subject: [PATCH] docs(release): add RELEASE.md --- RELEASE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000000..ae7de1fe65 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,11 @@ +# Creating a Release + +[GitHub](https://github.com/orhun/git-cliff/releases), [crates.io](https://crates.io/crates/git-cliff/) and [Docker Hub](https://hub.docker.com/repository/docker/orhunp/git-cliff) releases are automated via [GitHub actions](./.github/workflows/cd.yml) and triggered by pushing a tag. + +1. Bump the version in [Cargo.toml](./Cargo.toml) according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +2. Update [Cargo.lock](./Cargo.lock) by building the project via `cargo build`. +3. Run the [release script](./release.sh): `./release.sh v[X.Y.Z]` +4. Push the changes: `git push` +5. Check if [Continuous Integration](https://github.com/orhun/git-cliff/actions) workflow is completed successfully. +6. Push the tags: `git push --tags` +7. Wait for [Continuous Deployment](https://github.com/orhun/git-cliff/actions) workflow to finish.