Add release steps

syncs-usyd · Aug 30, 2023 · 2cb0296 · 2cb0296
1 parent 4966b77
commit 2cb0296
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,3 +16,8 @@ make
 ```
 
 The output is a file called `constitution.pdf`.
+
+# Creating a release
+
+1. Tag the commit locally using `git tag <tag-name>`. The `<tag-name>` should be the date of the constitution change in `YYYY-MM-DD` format.
+2. Push the tag to Github by using `git push origin <tag-name>`. This will trigger a Github Action to automatically build and publish the constitution in pdf.