From f3f9c12e8052df2526f99c552eeaad8cf61d5227 Mon Sep 17 00:00:00 2001 From: defelmnq Date: Wed, 22 Jan 2025 12:41:16 +0100 Subject: [PATCH 1/2] update readme release section --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6f13efef..0e76e554 100644 --- a/README.md +++ b/README.md @@ -77,3 +77,18 @@ To run these integration tests locally: > **Note:** you can specify `CODER_IMAGE` if the Coder image you wish to test is hosted somewhere other than `ghcr.io/coder/coder`. > For example, `CODER_IMAGE=example.com/repo/coder CODER_VERSION=foobar make test-integration`. + +### How to create a new release +> **Warning:** Before creating a new release, make sure you have pulled the latest commit from the main branch. + +1. Create a new tag with a version number (following semantic versioning): + ```console + git tag -a v2.1.2 -m "v2.1.2" + ``` + +2. Push the tag to the remote repository: + ```console + git push origin tag v2.1.2 + ``` + +A GitHub Actions workflow named "Release" will automatically trigger, run integration tests, and publish the new release. \ No newline at end of file From c8007d4dc00dc51f23ee366fa9b5b35bed0f534d Mon Sep 17 00:00:00 2001 From: Vincent Vielle Date: Wed, 22 Jan 2025 14:18:31 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Muhammad Atif Ali --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e76e554..cf012c46 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ To run these integration tests locally: > For example, `CODER_IMAGE=example.com/repo/coder CODER_VERSION=foobar make test-integration`. ### How to create a new release -> **Warning:** Before creating a new release, make sure you have pulled the latest commit from the main branch. +> **Warning:** Before creating a new release, make sure you have pulled the latest commit from the main branch i.e. `git pull origin main` 1. Create a new tag with a version number (following semantic versioning): ```console