@@ -24,6 +24,17 @@ Check that PRs have:
2424- [ ] Proper frontmatter in README
2525- [ ] Working tests (` bun test ` )
2626- [ ] Formatted code (` bun run fmt ` )
27+ - [ ] Avatar image for new namespaces (in ` images/ ` directory)
28+
29+ #### Version Guidelines
30+
31+ When reviewing PRs, ensure the version change follows semantic versioning:
32+
33+ - ** Patch** (1.2.3 → 1.2.4): Bug fixes
34+ - ** Minor** (1.2.3 → 1.3.0): New features, adding inputs
35+ - ** Major** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing types)
36+
37+ PRs should clearly indicate the version change (e.g., ` v1.2.3 → v1.2.4 ` ).
2738
2839### Validate READMEs
2940
@@ -37,17 +48,23 @@ go build ./cmd/readmevalidation && ./readmevalidation
3748
3849After merging a PR:
3950
51+ 1 . Get the new version from the PR (shown as ` old → new ` )
52+ 2 . Checkout the merge commit and create the tag:
53+
4054``` bash
55+ # Checkout the merge commit
4156git checkout MERGE_COMMIT_ID
57+
58+ # Create and push the release tag using the version from the PR
4259git tag -a " release/$namespace /$module /v$version " -m " Release $namespace /$module v$version "
4360git push origin release/$namespace /$module /v$version
4461```
4562
46- ### Version Numbers
63+ Example: If PR shows ` v1.2.3 → v1.2.4 ` , use ` v1.2.4 ` in the tag.
4764
48- - ** Patch ** (1.2.3 → 1.2.4): Bug fixes
49- - ** Minor ** (1.2.3 → 1.3.0): New features, adding inputs
50- - ** Major ** (1.2.3 → 2.0.0): Breaking changes
65+ ### Publishing
66+
67+ Changes are automatically published to [ registry.coder.com ] ( https://registry.coder.com ) after tags are pushed.
5168
5269## README Requirements
5370
@@ -67,6 +84,7 @@ tags: ["tag1", "tag2"]
6784` ` ` yaml
6885display_name : " Your Name"
6986bio : " Brief description"
87+ avatar_url : " ./images/avatar.png" # Path to avatar image
7088github : " username"
7189status : " community" # or "partner", "official"
7290` ` `
@@ -77,13 +95,4 @@ status: "community" # or "partner", "official"
7795- **Tests fail**: Ensure Docker with ` --network=host`, check Terraform syntax
7896- **Wrong file structure**: Use `./scripts/new_module.sh` for new modules
7997
80- # # Emergency
81-
82- # ## Revert Release
83-
84- ` ` ` bash
85- git tag -d release/$namespace/$module/v$version
86- git push origin :refs/tags/release/$namespace/$module/v$version
87- ` ` `
88-
8998That's it. Keep it simple.
0 commit comments