Skip to content

Commit 3c23e37

Browse files
defelmnqmatifali
andauthored
doc: add release section (#328)
* update readme release section * Update README.md Co-authored-by: Muhammad Atif Ali <[email protected]> --------- Co-authored-by: Muhammad Atif Ali <[email protected]>
1 parent 464d613 commit 3c23e37

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,18 @@ To run these integration tests locally:
7777

7878
> **Note:** you can specify `CODER_IMAGE` if the Coder image you wish to test is hosted somewhere other than `ghcr.io/coder/coder`.
7979
> For example, `CODER_IMAGE=example.com/repo/coder CODER_VERSION=foobar make test-integration`.
80+
81+
### How to create a new release
82+
> **Warning:** Before creating a new release, make sure you have pulled the latest commit from the main branch i.e. `git pull origin main`
83+
84+
1. Create a new tag with a version number (following semantic versioning):
85+
```console
86+
git tag -a v2.1.2 -m "v2.1.2"
87+
```
88+
89+
2. Push the tag to the remote repository:
90+
```console
91+
git push origin tag v2.1.2
92+
```
93+
94+
A GitHub Actions workflow named "Release" will automatically trigger, run integration tests, and publish the new release.

0 commit comments

Comments
 (0)