From c9f92b8683b11ed06d0300143c1d86ee848eca13 Mon Sep 17 00:00:00 2001 From: Mattias Reichel Date: Wed, 12 Feb 2025 09:37:20 +0100 Subject: [PATCH] docs: Add release instructions for auto-updating major versions Include details on how to manage releases so that the major version references (e.g., v3) automatically point to the latest stable release. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index a5d9b8f02..075875667 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,25 @@ Below you'll find a description of what each option does. With the action correctly configured you should see the workflow trigger the deployment under the configured conditions. ![Example](screenshot.png) + +## Releasing a new version + +To release a new version, you need to create a new tag with the version number (prefixed with v). This can be done via +the GitHub Releases page or via the command line. +```console +git tag v3.0 +git push origin v3.0 +``` + +To make major version references work, create a new branch with the major version number (if it does not already exist). +```console +git checkout -b v3 v3.0 +git push origin v3 +``` + +When a new minor version is released, update the major version branch to point to the new release tag. +```console +git checkout v3 +git reset --hard v3.1 +git push --force origin v3 +``` \ No newline at end of file