Merge pull request #624 from fede1024/scanterog/instructions

Update release notes
fede1024 · Nov 7, 2023 · c87c1e7 · c87c1e7
2 parents d425a60 + 3e9ebef
commit c87c1e7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -50,11 +50,12 @@ autocreation in order for the tests to succeed.
 
 ## Releasing
 
-* Ensure `rdkafka-sys` has no unreleased changes.
-* Ensure the changelog is up to date.
-* Ensure Cargo.toml is up to date.
+* Checkout into master and pull the latest changes.
+* Ensure `rdkafka-sys` has no unreleased changes. If it does, release `rdkafka-sys` first.
+* Ensure the changelog is up to date (i.e not Unreleased changes).
 * Run `./generate_readme.py > README.md`.
+* Bump the version in Cargo.toml and commit locally.
+* Run `cargo publish`.
 * Run `git tag -am $VERSION $VERSION`.
 * Run `git push`.
 * Run `git push origin $VERSION`.
-* Run `cargo publish`.
diff --git a/rdkafka-sys/CONTRIBUTING.md b/rdkafka-sys/CONTRIBUTING.md
@@ -19,7 +19,9 @@ Then:
 
 ## Releasing
 
-* Ensure the changelog is up to date.
-* Ensure Cargo.toml is up to date.
+* Checkout into master and pull the latest changes.
+* Ensure the changelog is up to date (i.e not Unreleased changes).
 * Run `cd rdkafka-sys && ../generate_readme.py > README.md`.
+* Bump the version in Cargo.toml and commit locally.
 * Run `cargo publish`.
+* Push the commit.