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

Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Commit 982c75e

Browse files
committed
fix: update incorrect info in docs
1 parent 096cd21 commit 982c75e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ module "example" {
5353
## Releases
5454

5555
> [!WARNING]
56-
> Version numbers are very important for publishing to Terraform. If the version number is incorrect in any way, there is a risk that some modules could stop working.
56+
> When creating a new release, make sure that your new version number is fully accurate. If a version number is incorrect or does not exist, we may end up serving incorrect/old data for our various tools and providers.
5757
5858
Much of our release process is automated. To cut a new release:
5959

6060
1. Navigate to [GitHub's Releases page](https://github.com/coder/modules/releases)
6161
2. Click "Draft a new release"
6262
3. Click the "Choose a tag" button and type a new release number in the format `v<major>.<minor>.<patch>` (e.g., `v1.18.0`). Then click "Create new tag".
63-
4. Click the "Generate release notes" button, and clean up the resulting README. Be sure to clean up any notes that would not be relevant to end-users (e.g., bumping dependencies).
63+
4. Click the "Generate release notes" button, and clean up the resulting README. Be sure to remove any notes that would not be relevant to end-users (e.g., bumping dependencies).
6464
5. Once everything looks good, click the "Publish release" button.
6565

6666
Once the release has been cut, a script will run to check whether there are any modules that will require that the new release number be published to Terraform. If there are any, a new pull request will automatically be generated. Be sure to approve this PR and merge it into the `main` branch.
@@ -71,4 +71,4 @@ Following that, our automated processes will handle publishing new data for [`re
7171
2. Publishing new data to the [Coder Registry](https://registry.coder.com)
7272

7373
> [!NOTE]
74-
> Some data in `registry.coder.com` is fetched on demand from the Module repo's main branch. As such, some changes will be made almost immediately, while others may require some time.
74+
> Some data in `registry.coder.com` is fetched on demand from the Module repo's main branch. This data should be updated almost immediately after a new release, but other changes will take some time to propagate.

0 commit comments

Comments
 (0)