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

dcrjson: Introduce v4 module. #2733

Merged
merged 1 commit into from Sep 14, 2021
Merged

Conversation

davecgh
Copy link
Member

@davecgh davecgh commented Sep 5, 2021

The current latest code for dcrjson already has breaking changes compared to the last release and was unfortunately not preceded by starting a new major version module per the standard process.

Fortunately, the two modules in this repo that use dcrjson, namely rpcclient and rpc/json/rpctypes, do not use any of its types directly in their public API nor have any replacements to the code that contains the changes that require a new major version, so neither require a major version bump as a result.

Therefore, this is able to mostly follow the process for introducing major API breaks as follows:

  • Bump the major version in the go.mod of the affected module if not already done since the last release tag
  • Add a replacement to the go.mod in the main module if not already done since the last release tag
  • Update all imports in the repo to use the new major version as necessary
  • Make necessary modifications to allow all other modules to use the new version in the same commit

@davecgh davecgh added this to the 1.7.0 milestone Sep 5, 2021
@davecgh davecgh mentioned this pull request Sep 5, 2021
The current latest code for dcrjson already has breaking changes
compared to the last release and was unfortunately not preceded by
starting a new major version module per the standard process.

Fortunately, the two modules in this repo that use dcrjson, namely
rpcclient and rpc/json/rpctypes, use any of its types directly in their
public API nor have any replacements to the code that contains the
changes that require a new major version, so neither require a major
version bump as a result.

Therefore, this is able to mostly follow the process for introducing
major API breaks as follows:

- Bump the major version in the go.mod of the affected module if not
  already done since the last release tag
- Add a replacement to the go.mod in the main module if not already done
  since the last release tag
- Update all imports in the repo to use the new major version as
  necessary
- Make necessary modifications to allow all other modules to use the new
  version in the same commit
@davecgh davecgh merged commit 99c8255 into decred:master Sep 14, 2021
@davecgh davecgh deleted the dcrjson_introduce_v4 branch September 14, 2021 18:57
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.

None yet

4 participants