Merge pull request #1428 from stevenengler/fix-bumpversion-doc

stevenengler · web-flow · commit 14f0c8790c39 · 2021-06-14T13:30:01.000-04:00
Fix docs to properly update the git tag after bumpversion
diff --git a/docs/maintainer_playbook.md b/docs/maintainer_playbook.md
@@ -15,17 +15,18 @@ git checkout main
 # that commit.
 bumpversion <patch|minor|major> --tag --commit
 
-# Update the Cargo lock files
+# Get the new version number.
+VERSION=`awk -F "=" '/current_version/ {print $2}' .bumpversion.cfg | tr -d ' '`
+
+# Update the Cargo lock files, then update the commit and tag
 (cd src/main && cargo update --workspace)
 (cd src/test && cargo update --workspace)
 git add src/main/Cargo.lock src/test/Cargo.lock
 git commit --amend --no-edit
-
-# Get the new version number.
-VERSION=`awk -F "=" '/current_version/ {print $2}' .bumpversion.cfg | tr -d ' '`
+git tag -f -a "v$VERSION"
 
 # Push to GitHub.
-git push origin v$VERSION
+git push origin "v$VERSION"
 ```
 
 Our releases will then be tagged off of the main branch.
