Skip to content

Commit

Permalink
docs(release): add RELEASE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Jun 29, 2021
1 parent 59b7c6e commit ce2246b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit ce2246b

Please sign in to comment.