Skip to content

Commit 9788acb

Browse files
chore: update CONTRIBUTING.md to replace incomplete release script with manual instruction. (#100)
- Revised the release process description for better clarity. - Added detailed steps for creating and pushing annotated tags. - Updated notes on version numbering and publishing to the Coder Registry.
1 parent 9a2e48b commit 9788acb

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Additional image/video assets can be placed in one of two places:
242242
243243
## Releases
244244
245-
The release process is automated with these steps:
245+
The release process involves the following steps:
246246
247247
### 1. Create and merge a new PR
248248
@@ -253,33 +253,42 @@ The release process is automated with these steps:
253253
254254
After merging to `main`, a maintainer will:
255255
256-
- View all modules and their current versions:
256+
- Check out the merge commit:
257257
258258
```shell
259-
./release.sh --list
259+
git checkout MERGE_COMMIT_ID
260260
```
261261

262-
- Determine the next version number based on changes:
262+
- Create annotated tags for each module that was changed:
263263

264-
- **Patch version** (1.2.3 → 1.2.4): Bug fixes
265-
- **Minor version** (1.2.3 → 1.3.0): New features, adding inputs, deprecating inputs
266-
- **Major version** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing input types)
264+
```shell
265+
git tag -a "release/$namespace/$module/v$version" -m "Release $namespace/$module v$version"
266+
```
267267

268-
- Create and push an annotated tag:
268+
- Push the tags to origin:
269269

270270
```shell
271-
# Fetch latest changes
272-
git fetch origin
273-
274-
# Create and push tag
275-
./release.sh module-name 1.2.3 --push
271+
git push origin release/$namespace/$module/v$version
276272
```
277273

278-
The tag format will be: `release/module-name/v1.2.3`
274+
For example, to release version 1.0.14 of the coder/aider module:
275+
276+
```shell
277+
git tag -a "release/coder/aider/v1.0.14" -m "Release coder/aider v1.0.14"
278+
git push origin release/coder/aider/v1.0.14
279+
```
280+
281+
### Version Numbers
282+
283+
Version numbers should follow semantic versioning:
284+
285+
- **Patch version** (1.2.3 → 1.2.4): Bug fixes
286+
- **Minor version** (1.2.3 → 1.3.0): New features, adding inputs, deprecating inputs
287+
- **Major version** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing input types)
279288

280289
### 3. Publishing to Coder Registry
281290

282-
Our automated processes will handle publishing new data to [registry.coder.com](https://registry.coder.com).
291+
After tags are pushed, the changes will be published to [registry.coder.com](https://registry.coder.com).
283292

284293
> [!NOTE]
285-
> Some data in registry.coder.com is fetched on demand from the [coder/modules](https://github.com/coder/modules) repo's `main` branch. This data should update almost immediately after a release, while other changes will take some time to propagate.
294+
> Some data in registry.coder.com is fetched on demand from this repository's `main` branch. This data should update almost immediately after a release, while other changes will take some time to propagate.

0 commit comments

Comments
 (0)