-
-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |