Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: update CONTRIBUTING.md to replace incomplete release script with manual instruction. #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
+25 −16
Merged

chore: update CONTRIBUTING.md to replace incomplete release script with manual instruction. #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 25 additions & 16 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Additional image/video assets can be placed in one of two places:

## Releases

The release process is automated with these steps:
The release process involves the following steps:

### 1. Create and merge a new PR

Expand All @@ -253,33 +253,42 @@ The release process is automated with these steps:

After merging to `main`, a maintainer will:

- View all modules and their current versions:
- Check out the merge commit:

```shell
./release.sh --list
git checkout MERGE_COMMIT_ID
```

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

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

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

```shell
# Fetch latest changes
git fetch origin

# Create and push tag
./release.sh module-name 1.2.3 --push
git push origin release/$namespace/$module/v$version
```

The tag format will be: `release/module-name/v1.2.3`
For example, to release version 1.0.14 of the coder/aider module:

```shell
git tag -a "release/coder/aider/v1.0.14" -m "Release coder/aider v1.0.14"
git push origin release/coder/aider/v1.0.14
```

### Version Numbers

Version numbers should follow semantic versioning:

- **Patch version** (1.2.3 → 1.2.4): Bug fixes
- **Minor version** (1.2.3 → 1.3.0): New features, adding inputs, deprecating inputs
- **Major version** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing input types)
Comment on lines +281 to +287
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should actually be mentioned well before, for the author to put the correct tag in README.md. The maintainer would simply tag whatever tag is in the README while ensuring it's correct as per these rules and ask for changes if not.


### 3. Publishing to Coder Registry

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

> [!NOTE]
> 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.
> 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.