Skip to content
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.

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

Align git tag with Go module version #45

Closed
florianl opened this issue Mar 23, 2024 · 1 comment
Closed

Align git tag with Go module version #45

florianl opened this issue Mar 23, 2024 · 1 comment

Comments

@florianl
Copy link
Owner

In the past git tag versioning and Go module versioning diverged on this repository. As a result there are pitfalls to using this Go package.

  • Clarity and Consistency: Matching the Go module version with a Git tag creates a clear correspondence between the code and its version. This makes it easier for developers to understand exactly which code revision they are using.

  • Dependency Management: The go tool relies on Git tags to identify specific versions of Go modules. When the module version and Git tag are aligned, the go tool can effortlessly download and manage dependencies. This ensures everyone using your module gets the intended version.

  • Version Discovery: Proxy services like the Go proxy (https://proxy.golang.org/) use Git tags to discover new module versions. Aligning the versions allows for faster discovery and adoption of new releases by consumers of your module.

To start aligning git tags with Go module versions, the following changes are planned for May 2024::

Introduce a new major git tag

Use this new major git tag as Go module version

From this point onwards major git tags should always be aligned with Go module versions.

@florianl
Copy link
Owner Author

Resolved with #53.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant