Skip to content

Commit eb04c7b

Browse files
authored
Update section in CONTRIBUTING about release tags (#2038)
1 parent 2781f5c commit eb04c7b

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

CONTRIBUTING.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -185,14 +185,17 @@ make run-docs-server
185185

186186
## Publishing a release
187187

188-
This project has a [GitHub Actions workflow](https://github.com/replicate/cog/blob/39cfc5c44ab81832886c9139ee130296f1585b28/.github/workflows/ci.yaml#L107) that uses [goreleaser](https://goreleaser.com/quick-start/#quick-start) to facilitate the process of publishing new releases. The release process is triggered by manually creating and pushing a new git tag.
188+
This project has a [GitHub Actions workflow](https://github.com/replicate/cog/blob/39cfc5c44ab81832886c9139ee130296f1585b28/.github/workflows/ci.yaml#L107) that uses [goreleaser](https://goreleaser.com/quick-start/#quick-start) to facilitate the process of publishing new releases. The release process is triggered by manually creating and pushing a new annotated git tag.
189189

190-
To publish a new release, run the following in your local checkout of cog:
190+
> Deciding what the annotated git tag should be requires some interpretation. Cog generally follows [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html), and since the major version
191+
> is `0`, the rules get [a bit more loose](https://semver.org/spec/v2.0.0.html#spec-item-4). Broadly speaking, the rules for when to increment the patch version still hold, but
192+
> backward-incompatible changes **will not** require incrementing the major version. In this way, the minor version may be incremented whether the changes are additive or
193+
> subtractive. This all changes once the major version is incremented to `1`.
191194
192-
git checkout main
193-
git fetch --all --tags
194-
git tag v0.0.11
195-
git push --tags
195+
To publish a new release `v0.13.12` referencing commit `fabdadbead`, for example, one would run the following in one's local checkout of cog:
196+
197+
git tag --sign --annotate --message 'Release v0.13.12' v0.13.12 fabdadbead
198+
git push origin v0.13.12
196199

197200
Then visit [github.com/replicate/cog/actions](https://github.com/replicate/cog/actions) to monitor the release process.
198201

0 commit comments

Comments
 (0)