Skip to content

Commit 2974b96

Browse files
authored
Merge branch 'main' into anasfanani/module-vscode-web-platform-setting
2 parents 3f72edb + 9788acb commit 2974b96

File tree

56 files changed

+1674
-163
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1674
-163
lines changed

.icons/aider.svg

Lines changed: 3 additions & 0 deletions
Loading

CONTRIBUTING.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ In addition to the general criteria, all README files must have the following:
227227
```tf
228228
module "cursor" {
229229
count = data.coder_workspace.me.start_count
230-
source = "registry.coder.com/modules/cursor/coder"
230+
source = "registry.coder.com/coder/cursor/coder"
231231
version = "1.0.19"
232232
agent_id = coder_agent.example.id
233233
}
@@ -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.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ In both cases, the main README contains a Terraform snippet for integrating the
3737
```tf
3838
module "cursor" {
3939
count = data.coder_workspace.me.start_count
40-
source = "registry.coder.com/modules/cursor/coder"
40+
source = "registry.coder.com/coder/cursor/coder"
4141
version = "1.0.19"
4242
agent_id = coder_agent.example.id
4343
}

cmd/readmevalidation/testSamples/sampleReadmeBody.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Run the [Goose](https://block.github.io/goose/) agent in your workspace to gener
44

55
```tf
66
module "goose" {
7-
source = "registry.coder.com/modules/goose/coder"
7+
source = "registry.coder.com/coder/goose/coder"
88
version = "1.0.31"
99
agent_id = coder_agent.example.id
1010
folder = "/home/coder"
@@ -38,7 +38,7 @@ Your workspace must have `screen` installed to use this.
3838
```tf
3939
module "coder-login" {
4040
count = data.coder_workspace.me.start_count
41-
source = "registry.coder.com/modules/coder-login/coder"
41+
source = "registry.coder.com/coder/coder-login/coder"
4242
version = "1.0.15"
4343
agent_id = coder_agent.example.id
4444
}
@@ -80,7 +80,7 @@ resource "coder_agent" "main" {
8080
8181
module "goose" {
8282
count = data.coder_workspace.me.start_count
83-
source = "registry.coder.com/modules/goose/coder"
83+
source = "registry.coder.com/coder/goose/coder"
8484
version = "1.0.31"
8585
agent_id = coder_agent.example.id
8686
folder = "/home/coder"
@@ -108,7 +108,7 @@ Run Goose as a standalone app in your workspace. This will install Goose and run
108108

109109
```tf
110110
module "goose" {
111-
source = "registry.coder.com/modules/goose/coder"
111+
source = "registry.coder.com/coder/goose/coder"
112112
version = "1.0.31"
113113
agent_id = coder_agent.example.id
114114
folder = "/home/coder"

0 commit comments

Comments
 (0)