Tools: Improve docs for get_release_contributors

jamulussoftware · Feb 20, 2022 · 0ca2870 · 0ca2870
1 parent 61f78c9
commit 0ca2870
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/tools/get_release_contributors.py b/tools/get_release_contributors.py
@@ -5,8 +5,15 @@
 May need a Github Personal access token to avoid hitting rate limits.
 
 Usage:
-./tools/get_release_contributors.py --from release --to translate3_7_0 --github-token YOUR_TOKEN --repo /path/to/your/jamuluswebsite
-./tools/get_release_contributors.py --from r3_6_2 --to r3_7_0rc1 --github-token YOUR_TOKEN --repo /path/to/your/jamulus
+
+## Website repo (jamulussoftware/jamuluswebsite)
+- cd jamuluswebsite
+- git log --oneline release # Find commit ID of previous version. Search for "RELEASE:"
+- /path/to/jamulussoftware/code/tools/get_release_contributors.py --from COMMIT_ID_FROM_PREVIOUS_STEP --to next-release --github-token YOUR_TOKEN --repo .
+
+## Code repo (jamulussoftware/jamulus)
+- git pull -C /path/
+- ./tools/get_release_contributors.py --from r3_8_1 --to r3_8_2 --github-token YOUR_TOKEN --repo .
 
 """
 import requests