-
Notifications
You must be signed in to change notification settings - Fork 28
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
Prepare for 2.0.0 release. #437
Conversation
README.md
Outdated
@@ -65,7 +65,7 @@ mining, a certificate from an authority (`CA`) like | |||
command without cloning this repository: | |||
|
|||
```sh | |||
$ go install github.com/decred/dcrpool@v1.3.0 | |||
$ go install github.com/decred/dcrpool@v2.0.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't work. The reason we use release-v2.0.0
is because if you use v2.0.0
you will have to bump the major module version to include /v2
in the go.mod
, meaning this would have to be go install github.com/decred/dcrpool/[email protected]
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, I see that the pool
package is not internal and thus if its API changes in a breaking way, the main dcrpool
module needs to have its major bumped.
I compared against v.1.2.0
via git diff v1.2.0..HEAD pool
and I see that at the very least pool.ChainStateConfig
, pool.ClientConfig
, and pool.EndpointConfig
were changed in a breaking way, so that technically forces the main dcrpool
module to become /v2
.
We can probably get away with not bumping it though because there are no external importers of the module.
For what it's worth, this is why there should not be any code exported from the main module at all when the main module is the application itself. It's a mistake that dcrwallet
makes too. It constantly forces major module version bumps which is super annoying for consumers and constantly break install scripts, version linker flags (because they have to become .../v2.Release
) , etc.
The pool
package should probably be moved to internal to avoid this issue in the future.
18aede6
to
2806af1
Compare
The earlier commit to change the version to 1.3.0 was a mistake. The major version needs to be bumped due to changes to the database code which are not backwards compatible.
2806af1
to
0da675b
Compare
Are you planning on creating the |
Exactly. Following this PR:
|
No description provided.