From 2cb02967e8e44dbf2ef5838a9b1e1a3d28121e58 Mon Sep 17 00:00:00 2001 From: Chen Kang Yang <30970698+chen-ky@users.noreply.github.com> Date: Wed, 30 Aug 2023 11:43:51 +1000 Subject: [PATCH] Add release steps --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 13cc894..c9e1a24 100644 --- 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 `. The `` should be the date of the constitution change in `YYYY-MM-DD` format. +2. Push the tag to Github by using `git push origin `. This will trigger a Github Action to automatically build and publish the constitution in pdf.