Adding codegen deprecation message #3243
Conversation
✅ Deploy Preview for apollo-ios-docs canceled.
|
| @@ -5,6 +5,7 @@ import OrderedCollections | |||
| #if os(macOS) | |||
|
|
|||
| /// A class to facilitate running code generation | |||
| @available(*, deprecated, message: "Starting with the upcoming 1.6.0 release, the code generation library will be its own SPM package which you will need to add as a dependency. For more details see here: https://github.com/apollographql/apollo-ios/issues/3240") | |||
There was a problem hiding this comment.
We can probably remove the word "upcoming" given that we want to release these in tandem? So that folks who are pedantic about no warnings can do the change to 1.6.0 immediately.
There was a problem hiding this comment.
Or maybe not if the patch release will only be this deprecation. Then they have no motivation to stay on it and can rollback to the previous (current) release prior to the warning.
There was a problem hiding this comment.
If we do end up shipping a subsequent patch to 1.5.x then maybe it would be prudent for the user to be able to hide this message with an environment variable
There was a problem hiding this comment.
I think the idea is we push this patch ahead of time? Maybe I misunderstood the purpose though
There was a problem hiding this comment.
@bignimbus @AnthonyMDev thoughts?
There was a problem hiding this comment.
Ahead of 1.6.0 is fine but then the patch should only contain the deprecation otherwise people who want the other changes but no warnings couldn't stay on the patch release. If there are no other changes then they can see the message, decide they don't want the build warning and go back to the previous version. Once 1.6.0 is out they can catch-up and go from there.
There was a problem hiding this comment.
I'm not aware of any changes we have planned to ship in a patch release before 1.6.0 at this point.
Adding deprecation message to
ApolloCodegento alert users in advance of the upcoming 1.6.0 changes.