From c873be5cedf7b83ab7b05383615f5eb6a70264ed Mon Sep 17 00:00:00 2001 From: haydenccarroll Date: Fri, 8 Dec 2023 10:22:46 -0800 Subject: [PATCH] docs: update readme with tag update instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 720eae9..d884854 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,14 @@ There should also be tags that are updated after every update to a major version - example: `go/app/v1` +To update a tag, you can use run the following commands after merging your changes to main: +```bash +git checkout main +git pull +git tag go/app/v1 -f +git push origin go/app/v1 -f +``` + This will allow users to specify a major version and always be up to date with minor updates. As such, whenever changes are made to workflow templates and a tag is to be created, the major version should increment if there are any major changes to a workflow. This is up to the discresion of the person making the tag, but some possible reasons to increment the major version include but are not limited to: