more release automation (#2796)

* automatically publish after cli release is created

* a more accurate term

* explain --no-publish

Author: tshepang

.github/workflows/publish.yml

@@ -1,13 +1,16 @@
-# To trigger this:
-# - go to Actions > Publish
-# - click the Run Workflow dropdown in the top-right
-name: Publish
-on: workflow_dispatch
+# This is triggered after the Release workflow successfully completes its run
+on:
+  workflow_run:
+    workflows:
+      - Release
+    types:
+      - completed
 env:
   CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 jobs:
   cargo-publish:
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v3

CONTRIBUTING.md

@@ -563,7 +563,7 @@ cargo release [patch|minor] --no-publish --execute
 This does the following:
 
 - Bump the version.
-- Turn the `Unreleased` section of the changelog into the section for the version being published.
+- Turn the `Unreleased` section of the changelog into the section for the version being released.
 - Update the table of contents of the changelog using `doctoc`.
 - Tag (`git tag`) the HEAD commit
 - Push (`git push`) to GitHub
@@ -573,6 +573,10 @@ The `patch` and `minor` refer to semver concepts:
 - `patch` would bump __v0.68.1__ to __v0.68.2__
 - `minor` would bump __v0.68.2__ to __v0.69.0__
 
+> NOTE:
+> We use the `--no-publish` so that the crates are only published after the release is complete.
+> This is automatic, provided the release CI job is successful.
+
 ### Create a new release on Github
 
 The release is automated with the help of `.github/workflows/release.yml`,