You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -202,22 +202,21 @@ be applied selectively or to discourage anyone from contributing.
202
202
203
203
## Releases
204
204
205
-
Coder releases are automated via GitHub Actions. Specifically, the
206
-
[`release.yaml`](../.github/workflows/release.yaml) workflow. They are created
207
-
based on the current [`main`](https://github.com/coder/coder/tree/main) branch.
205
+
Coder releases are initiated via [`./scripts/release.sh`](../scripts/release.sh) and automated via GitHub Actions. Specifically, the [`release.yaml`](../.github/workflows/release.yaml) workflow. They are created based on the current [`main`](https://github.com/coder/coder/tree/main) branch.
208
206
209
-
The release notes for a release are automatically generated from commit titles
210
-
and metadata from PRs that are merged into `main`.
207
+
The release notes for a release are automatically generated from commit titles and metadata from PRs that are merged into `main`.
211
208
212
-
### Creating a release (script)
209
+
### Creating a release
213
210
214
-
The preferred way to create a release is to use[`./scripts/release.sh`](../scripts/release.sh). This script will show a preview of the release that _would_ be created and if you choose to continue, automatically run and watch the release workflow for you.
211
+
The creation of a release is initiated via[`./scripts/release.sh`](../scripts/release.sh). This script will show a preview of the release that will be created, and if you choose to continue, create and push the tag which will trigger the creation of the release via GitHub Actions.
215
212
216
213
See `./scripts/release.sh --help` for more information.
217
214
218
-
### Creating a release (workflow dispatch)
215
+
### Creating a release (via workflow dispatch)
219
216
220
-
Alternatively, the workflow can be dispatched manually from [Actions: Release](https://github.com/coder/coder/actions/workflows/release.yaml). Simply press "Run workflow" and set your preferred inputs.
217
+
Typically the workflow dispatch is only used to test (dry-run) a release, meaning no actual release will take place. The workflow can be dispatched manually from [Actions: Release](https://github.com/coder/coder/actions/workflows/release.yaml). Simply press "Run workflow" and choose dry-run.
218
+
219
+
If a release has failed after the tag has been created and pushed, it can be retried by again, pressing "Run workflow", changing "Use workflow from" from "Branch: main" to "Tag: vX.X.X" and not selecting dry-run.
0 commit comments