Skip to content

doc: add release section #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025
Merged

doc: add release section #328

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3f9c12
update readme release section
defelmnq Jan 22, 2025
c8007d4
Update README.md
defelmnq Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 i.e. `git pull origin main`

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.
Loading