readme: commands to generate release notes

dhimmel · Apr 4, 2021 · ece5a93 · ece5a93
1 parent f48bc0d
commit ece5a93
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -106,6 +106,11 @@ pre-commit run --all
 
 # run tests
 pytest
+
+# generate changelog for release notes
+git fetch --tags origin main
+OLD_TAG=$(git describe --tags --abbrev=0)
+git log --oneline --decorate=no --reverse $OLD_TAG..HEAD
 ```
 
 Maintainers can make a new release at <https://github.com/dhimmel/obonet/releases/new>.