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

go: use only major version in the module name #86

Merged
merged 1 commit into from
Dec 2, 2022

Conversation

mpkorstanje
Copy link
Contributor

@mpkorstanje mpkorstanje commented Nov 14, 2022

🤔 What's changed?

Following on cucumber/messages#107 we can conclude that

  1. only major versions should be used in go module files
  2. some project will have been released with a major.minor.patch version

This change will ensure that when a new major release is made:

module github.com/example/project/v0 will become module github.com/example/project/v1

and:

module github.com/example/project/v0.X.X will become: module github.com/example/project/v0.

This should fix the incorrect module names on the next version.

🏷️ What kind of change is this?

  • 🐛 Bug fix (non-breaking change which fixes a defect)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

@mpkorstanje mpkorstanje force-pushed the go-use-only-major-version-in-module branch from 463e8a1 to 735b135 Compare November 14, 2022 15:59
@mpkorstanje mpkorstanje mentioned this pull request Nov 14, 2022
7 tasks
@mpkorstanje mpkorstanje force-pushed the go-use-only-major-version-in-module branch 2 times, most recently from 0253490 to 0bb41d6 Compare November 14, 2022 16:05
@mpkorstanje mpkorstanje requested a review from vearutop November 14, 2022 16:06
@mpkorstanje mpkorstanje force-pushed the go-use-only-major-version-in-module branch from 0bb41d6 to bcabe9e Compare November 14, 2022 16:07
Following on cucumber/messages#107 we can conclude that

1. only major versions should be used in go module files
2. some project will have been released with a major.minor.patch version

This change will ensure that when a new major release is made:

`module github.com/example/project/v0` will become `module github.com/example/project/v1`

and:

`module github.com/example/project/v0.X.X` will become: `module github.com/example/project/v0`.

This should fix the incorrect module names on the next major version.
@mpkorstanje mpkorstanje force-pushed the go-use-only-major-version-in-module branch from bcabe9e to 27211e9 Compare November 14, 2022 16:40
Copy link
Member

@vearutop vearutop left a comment

Choose a reason for hiding this comment

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

Looks good to me, though I'd prefer to be more conservative with major bumps of a Go module for reasons mentioned here.

@mpkorstanje mpkorstanje merged commit d676ddb into main Dec 2, 2022
@mpkorstanje mpkorstanje deleted the go-use-only-major-version-in-module branch December 2, 2022 11:54
@mpkorstanje mpkorstanje mentioned this pull request Dec 17, 2022
7 tasks
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

Successfully merging this pull request may close these issues.

2 participants