9ed5084bfb
This PR updates all modules to remove maintainer_github field from
frontmatter.
I also updated a few modules to 1.0.31 to be later than the latest
general release on coder/modules.
⚠️ Modules Without Git Tags:
- coder/aws-region (README: v1.0.12) SHOULD BE: 1.0.31 Missed Tag
- coder/azure-region (README: v1.0.12) SHOULD BE: 1.0.31 Missed Tag
- coder/coder-login (README: v1.0.15) SHOULD BE: 1.0.31 Missed Tag
- coder/devcontainers-cli (README: v1.0.3) SHOULD BE: 1.0.31 Missed Tag
- coder/fly-region (README: v1.0.2) SHOULD BE: 1.0.31 Missed Tag
- coder/gcp-region (README: v1.0.12) SHOULD BE: 1.0.31 Missed Tag
- coder/git-commit-signing (README: v1.0.11) SHOULD BE: 1.0.31 Missed
Tag
- coder/git-config (README: v1.0.15) SHOULD BE: 1.0.31 Missed Tag
- coder/github-upload-public-key (README: v1.0.15) SHOULD BE: 1.0.31
Missed Tag
- coder/jfrog-oauth (README: v1.0.19) SHOULD BE: 1.0.31 Missed Tag
- coder/jfrog-token (README: v1.0.30) SHOULD BE: 1.0.31 Missed Tag
- coder/personalize (README: v1.0.2) SHOULD BE: 1.0.31 Missed Tag
- coder/slackme (README: v1.0.2) SHOULD BE: 1.0.31 Missed Tag
- coder/vault-github (README: v1.0.7) SHOULD BE: 1.0.31 Missed Tag
- coder/vault-jwt (README: v1.1.0) Missed Tag but correct
All of these modules have not been tagged since the move from
coder/modules. I believe they all need to move to 1.0.31 to outpace the
latest published general version from coder/modules.
Modules Updated:
- coder/agentapi: v1.0.0 → v1.0.1
- coder/aider: v1.1.0 → v1.1.1
- coder/amazon-dcv-windows: v1.1.0 → v1.1.1
- coder/amazon-q: v1.1.0 → v1.1.1
- coder/aws-region: v1.0.12 → v1.0.31
- coder/azure-region: v1.0.12 → v1.0.31
- coder/claude-code: v2.0.2 → v2.0.3
- coder/coder-login: v1.0.15 → v1.0.31
- coder/code-server: v1.3.0 → v1.3.1
- coder/cursor: v1.2.0 → v1.2.1
- coder/devcontainers-cli: v1.0.3 → v1.0.31
- coder/dotfiles: v1.2.0 → v1.2.1
- coder/filebrowser: v1.1.1 → v1.1.2
- coder/fly-region: v1.0.2 → v1.0.31
- coder/gcp-region: v1.0.12 → v1.0.31
- coder/git-clone: v1.1.0 → v1.1.1
- coder/git-commit-signing: v1.0.11 → v1.0.31
- coder/git-config: v1.0.15 → v1.0.31
- coder/github-upload-public-key: v1.0.15 → v1.0.31
- coder/goose: v2.0.0 → v2.0.1
- coder/hcp-vault-secrets: v1.0.32 → v1.0.33
- coder/jetbrains: v1.0.0 → v1.0.1
- coder/jetbrains-gateway: v1.2.1 → v1.2.2
- coder/jfrog-oauth: v1.0.19 → v1.0.31
- coder/jfrog-token: v1.0.30 → v1.0.31
- coder/jupyterlab: v1.1.0 → v1.1.1
- coder/jupyter-notebook: v1.1.0 → v1.1.1
- coder/kasmvnc: v1.2.0 → v1.2.1
- coder/local-windows-rdp: v1.0.1 → v1.0.2
- coder/personalize: v1.0.2 → v1.0.31
- coder/slackme: v1.0.2 → v1.0.31
- coder/vault-github: v1.0.7 → v1.0.31
- coder/vault-jwt: v1.1.0 → v1.1.1
- coder/vault-token: v1.2.0 → v1.2.1
- coder/vscode-desktop: v1.1.0 → v1.1.1
- coder/vscode-web: v1.3.0 → v1.3.1
- coder/windows-rdp: v1.2.2 → v1.2.3
- coder/windsurf: v1.1.0 → v1.1.1
- coder/zed: v1.0.0 → v1.0.1
98 lines
2.5 KiB
Markdown
98 lines
2.5 KiB
Markdown
# Maintainer Guide
|
|
|
|
Quick reference for maintaining the Coder Registry repository.
|
|
|
|
## Setup
|
|
|
|
Install Go for README validation:
|
|
|
|
```bash
|
|
# macOS
|
|
brew install go
|
|
|
|
# Linux
|
|
sudo apt install golang-go
|
|
```
|
|
|
|
## Reviewing a PR
|
|
|
|
Check that PRs have:
|
|
|
|
- [ ] All required files (`main.tf`, `main.test.ts`, `README.md`)
|
|
- [ ] Proper frontmatter in README
|
|
- [ ] Working tests (`bun test`)
|
|
- [ ] Formatted code (`bun run fmt`)
|
|
- [ ] Avatar image for new namespaces (`avatar.png` or `avatar.svg` in `.images/`)
|
|
|
|
### Version Guidelines
|
|
|
|
When reviewing PRs, ensure the version change follows semantic versioning:
|
|
|
|
- **Patch** (1.2.3 → 1.2.4): Bug fixes
|
|
- **Minor** (1.2.3 → 1.3.0): New features, adding inputs
|
|
- **Major** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing types)
|
|
|
|
PRs should clearly indicate the version change (e.g., `v1.2.3 → v1.2.4`).
|
|
|
|
### Validate READMEs
|
|
|
|
```bash
|
|
go build ./cmd/readmevalidation && ./readmevalidation
|
|
```
|
|
|
|
## Making a Release
|
|
|
|
### Create Release Tags
|
|
|
|
After merging a PR:
|
|
|
|
1. Get the new version from the PR (shown as `old → new`)
|
|
2. Checkout the merge commit and create the tag:
|
|
|
|
```bash
|
|
# Checkout the merge commit
|
|
git checkout MERGE_COMMIT_ID
|
|
|
|
# Create and push the release tag using the version from the PR
|
|
git tag -a "release/$namespace/$module/v$version" -m "Release $namespace/$module v$version"
|
|
git push origin release/$namespace/$module/v$version
|
|
```
|
|
|
|
Example: If PR shows `v1.2.3 → v1.2.4`, use `v1.2.4` in the tag.
|
|
|
|
### Publishing
|
|
|
|
Changes are automatically published to [registry.coder.com](https://registry.coder.com) after tags are pushed.
|
|
|
|
## README Requirements
|
|
|
|
### Module Frontmatter (Required)
|
|
|
|
```yaml
|
|
display_name: "Module Name"
|
|
description: "What it does"
|
|
icon: "../../../../.icons/tool.svg"
|
|
verified: false # Optional - Set by maintainers only
|
|
tags: ["tag1", "tag2"]
|
|
```
|
|
|
|
### Namespace Frontmatter (Required)
|
|
|
|
```yaml
|
|
display_name: "Your Name"
|
|
bio: "Brief description of who you are and what you do"
|
|
avatar_url: "./.images/avatar.png"
|
|
github: "username"
|
|
linkedin: "https://www.linkedin.com/in/username" # Optional
|
|
website: "https://yourwebsite.com" # Optional
|
|
support_email: "you@example.com" # Optional
|
|
status: "community" # or "partner", "official"
|
|
```
|
|
|
|
## Common Issues
|
|
|
|
- **README validation fails**: Check YAML syntax, ensure h1 header after frontmatter
|
|
- **Tests fail**: Ensure Docker with `--network=host`, check Terraform syntax
|
|
- **Wrong file structure**: Use `./scripts/new_module.sh` for new modules
|
|
- **Missing namespace avatar**: Must be `avatar.png` or `avatar.svg` in `.images/` directory
|