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

Further API breakages in 1.10.0 #1025

Closed
Lukasa opened this issue Jul 10, 2020 · 3 comments · Fixed by #1027
Closed

Further API breakages in 1.10.0 #1025

Lukasa opened this issue Jul 10, 2020 · 3 comments · Fixed by #1027
Assignees

Comments

@Lukasa
Copy link
Contributor

Lukasa commented Jul 10, 2020

Sorry folks, my issue yesterday (#1022) failed to catch the full suite of breakages we accidentally shipped in 1.10.0. I missed this at the time, but when we went to update another project we caught some more.

I finally decided to run SwiftNIO's check_no_api_breakages script, comparing 1.9.0 and 1.10.1. This is what else slipped through:

Checking SwiftProtobuf.json... ERROR
==============================
ERROR: public API change in SwiftProtobuf.json
==============================

/* Generic Signature Changes */

/* RawRepresentable Changes */

/* Removed Decls */

/* Moved Decls */

/* Renamed Decls */
Func Message.array(fromJSONString:options:) has been renamed to Func array(fromJSONString:extensions:options:)
Func Message.array(fromJSONUTF8Data:options:) has been renamed to Func array(fromJSONUTF8Data:extensions:options:)

/* Type Changes */
Func Message.array(fromJSONString:options:) has parameter 1 type change from SwiftProtobuf.JSONDecodingOptions to SwiftProtobuf.ExtensionMap
Func Message.array(fromJSONUTF8Data:options:) has parameter 1 type change from SwiftProtobuf.JSONDecodingOptions to SwiftProtobuf.ExtensionMap

/* Decl Attribute changes */

/* Fixed-layout Type Changes */

/* Protocol Conformance Change */

/* Protocol Requirement Change */

/* Class Inheritance Change */
Checking SwiftProtobufPluginLibrary.json... OK
done

This points out that we need the same patch as #1023 but for returning .array(fromJSONString:options:) and .array(fromJSONUTF8Data:options). This will require a 1.10.2.

Sorry about not running the full validation earlier. Perhaps we should consider integrating a variant of NIO's script to CI?

@thomasvl thomasvl self-assigned this Jul 10, 2020
@thomasvl
Copy link
Collaborator

I'll get to this later today.

re validation script - if there is one we can use, please open an issue with details so we can track setting that up. clearly something we should do. 😄

@Lukasa
Copy link
Contributor Author

Lukasa commented Jul 10, 2020

Sure, filed #1026.

thomasvl added a commit to thomasvl/swift-protobuf that referenced this issue Jul 10, 2020
thomasvl added a commit to thomasvl/swift-protobuf that referenced this issue Jul 10, 2020
@thomasvl
Copy link
Collaborator

Tagged and CocoaPods pushed.

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 a pull request may close this issue.

2 participants