Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

[in_app_purchase]Update the version number and CHANGELOG #4097

Merged

Conversation

ydag
Copy link
Contributor

@ydag ydag commented Jun 24, 2021

This PR is for updating the app_facing plugin's version number and CHANGELOG.md file since I create two PRs that have the breaking changes to handle the new PurchaseStatus named canceled in the in_app_purchase_ios and in_app_purchase_android platform plugins. This means developers can distinguish between an error and user cancellation.

Before merging this PR following PRs have to be merged :

Related issues:

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@ydag ydag requested review from cyanglaz and LHLL as code owners June 24, 2021 12:48
@google-cla google-cla bot added the cla: yes label Jun 24, 2021
@ydag ydag changed the title Update the version number and CHANGELOG [in_app_purchase]Update the version number and CHANGELOG Jun 24, 2021
@ydag ydag marked this pull request as draft July 7, 2021 09:23
@Hixie
Copy link
Contributor

Hixie commented Oct 26, 2021

In general I would recommend making the changelog and version changes in the PRs that land the changes, just in case something happens between one commit landing and the changelog commit landing.

@mvanbeusekom
Copy link
Contributor

In general I would recommend making the changelog and version changes in the PRs that land the changes, just in case something happens between one commit landing and the changelog commit landing.

@Hixie, in this case the changes are made in the in_app_purchase_android and in_app_purchase_ios packages, which are the platform specific implementations of this plugin. The in_app_purchase app-facing package depends on the mentioned platform implementations in it's pubspec.yaml file as follows:

dependencies:
  ...
  in_app_purchase_android: ^0.1.5
  in_app_purchase_ios: ^0.1.3+5

Since the changes in #4094 and #4095 are breaking changes respectively the in_app_purchase_ios and in_app_purchase_android packages we need to update the version of these dependencies in this package so the app-facing package takes those changes into effect. This is the whole reason for this PR to exist. To update the dependencies on the in_app_purchase_ios and in_app_purchase_android packages (once they are released) in the in_app_purchase app-facing package. It isn't possible to do this together in the PRs that made the platform specific changes since those changes need to landen and published first before we can update these dependencies. This is also the reason this PR is still in draft.

I will make sure that this will move forward as I am also working on moving #4094 and #4095 forward.

@mvanbeusekom mvanbeusekom marked this pull request as ready for review November 17, 2021 15:24
@@ -1,3 +1,8 @@
## 2.0.0

* BREAKING CHANGE : Refactor to handle new `PurchaseStatus` named `canceled`. This means developers
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: please update this to follow the new style guide: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style

So it should be:

* **BREAKING CHANGE**: Adds a new `PurchaseStatus` named [...]

@stuartmorgan-g
Copy link
Contributor

Wasn't the plan to do all of flutter/flutter#86076 before doing this?

@stuartmorgan-g
Copy link
Contributor

@mvanbeusekom Are all the pieces in? I just went through the list from the planned breakage and it seemed like they were all in, but I want to make sure I didn't miss anything.

If so, we can update this to cover all of the breaking changes and make it publishable again.

@mvanbeusekom
Copy link
Contributor

Yes all issues we discussed are in. Should I prepare an update for this PR or do you prefer to take care of this yourself?

@stuartmorgan-g
Copy link
Contributor

I'm more likely to get the CHANGELOG wrong, so if you want to update this PR to cover everything (or make a new PR if that's easier) that would be great.

@mvanbeusekom
Copy link
Contributor

@stuartmorgan I have updated the CHANGELOG and fixed merge conflicts. Could please have another look at the changelog?

@mvanbeusekom mvanbeusekom force-pushed the iap/app_facing_add_cancel_status branch from 675603d to c701883 Compare November 30, 2021 22:43
@@ -1,9 +1,13 @@
## NEXT
## 2.0.0

* Fixes integration tests.
* Updates example app Android compileSdkVersion to 31.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: these two lines should probably go to the end since they are not important to clients. We could swap these with the breaking changes section so that's first (rather than having a sublist in the middle of the list).

Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

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

LGTM once the analyzer issues from picking up the deprecation are fixed.

@mvanbeusekom mvanbeusekom added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Dec 1, 2021
@fluttergithubbot fluttergithubbot merged commit 71496dc into flutter:master Dec 1, 2021
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 1, 2021
amantoux pushed a commit to amantoux/plugins that referenced this pull request Dec 11, 2021
KyleFin pushed a commit to KyleFin/plugins that referenced this pull request Dec 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes p: in_app_purchase waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[in_app_purchase] Ability to discern error versus cancel in PurchaseStatus.error
5 participants