Document the Go module release system (prefixed tags) #422
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Go modules defined in a subdirectory need release tags prefixed with the subdirectory name in order to be recognized [1]. Based on us storing our Go module in the `backend-go` subdirectory of the repo, we therefore need tags prefixed with `backend-go/[release-version]`. For `v1.0.0-alpha.4` (due to caching problems), this was verified to work with the tag `backend-go/v1.0.0-goalpha.4`, which was found by pkg.go.dev [2]. This commit documents this knowledge (for now inside the Go package `README.md`), until a more formal release workflow documentation / automation gets established. * [1] https://web.archive.org/web/20240127035037/https://go.dev/ref/mod#vcs-version * [2] https://pkg.go.dev/github.com/wuespace/telestion/[email protected]
|
Current dependencies on/for this PR: This stack of pull requests is managed by Graphite. |
pklaschka
added
📕 documentation
Graphite App
pklaschka
deleted the
02-03-Document_the_Go_module_release_system_prefixed_tags_
branch
Merge activity
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Go modules defined in a subdirectory need release tags prefixed with the subdirectory name in order to be recognized [1].
Based on us storing our Go module in the
backend-gosubdirectory of the repo, we therefore need tags prefixed withbackend-go/[release-version].For
v1.0.0-alpha.4(due to caching problems), this was verified to work with the tagbackend-go/v1.0.0-goalpha.4, which was found by pkg.go.dev [2].This commit documents this knowledge (for now inside the Go package
README.md), until a more formal release workflow documentation / automation gets established.