Skip to content

Commit

Permalink
docs(release): document the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Sep 30, 2023
1 parent 9ce39fc commit de3881d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Creating a Release

The releases are automated via [`release-plz`](https://github.com/MarcoIeni/release-plz), [`cargo-dist`](https://github.com/axodotdev/cargo-dist) and [GitHub Actions](https://docs.github.com/en/actions).

1. Run `release-plz release-pr` to create a pull request representing the new release.

- Use `release-plz update` to see the changes locally if needed.

2. After merging the release PR, `git pull` your changes and run `release-plz release`.

- This will create a tag and update the [crates.io](https://crates.io/crates/daktilo) release.

3. Run `git push --tags` the tag.

- This will trigger `cargo-dist` and release binaries will be built in via [release workflow](.github/workflows/release.yml).

4. Mark the package out-of-date for package managers.

5. Announce the release on social platforms. 🥳

0 comments on commit de3881d

Please sign in to comment.