Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Commit

Permalink
Update release docs and tweak the scripts a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
kelnos committed Mar 24, 2022
1 parent 15d10cf commit 413e70a
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 4 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ jobs:
profile: minimal
override: true
- name: Publish release
run: ./release.sh ${{ secrets.CRATES_IO_TOKEN }}
run: ./.github/release.sh ${{ secrets.CRATES_IO_TOKEN }}
19 changes: 16 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
# Releasing this crate

## Prerequisites

* Ensure you have a GPG keypair created that you can use to sign the
release tag.
* Install `toml` with `cargo install toml`.

## Releasing

1. Run `./prepare-release.sh NEW_VERSION` (substituting the new desired
version for `NEW_VERSION`).
2. Go to the GitHub releases page for this repo. There should be a
draft release waiting. Edit it, set the title to the new version,
and point it to the new tag that was just pushed.
3. Once the release is created, GitHub Actions will build the new
release and publish it to crates.io.
point it to the new tag that was just pushed, and scan through the
release notes to ensure they seem sane. When you click the Publish
button, GitHub Actions will build the new release and publish it to
crates.io.

## TODO

* Use the GH API to do step #2 above.
7 changes: 7 additions & 0 deletions prepare-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,10 @@ cargo update --package espmonitor
git commit -a -m "Bump to $dev_version"

git push --tags origin "$(git rev-parse --abbrev-ref HEAD)"

echo 'Now visit:'
echo
echo 'https://github.com/esp-rs/espmonitor/releases/'
echo
echo 'Rename the draft release, point the release to the newly-created tag, and'
echo 'publish the release. GH Actions will take care of publishing to crates.io'

0 comments on commit 413e70a

Please sign in to comment.