Skip to content

docs: add breaking change notice to postinstall #2214

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

Merged
merged 2 commits into from
Jun 11, 2019

Conversation

mikehardy
Copy link
Collaborator

As discussed with you guys, and paired with the docs PR here invertase/react-native-firebase-docs#187 - I want to give the installed base a big heads-up that we may issue breaking releases in v5 minor releases during the transition to v6

I don't intend to propose anything crazy but sometimes maintenance requires a break when you are dependent on underlying libraries out of your control, and this gives us the space to break if we need to

This completes the effort to notify - we notify on package install, in the install docs, and in the release notes now, no one can say we didn't try, and the community should be able to self-resolve issues so it doesn't cause a support burden

Checklist

Test Plan

I worked on it until it displayed correctly on install, it looks like this:

Screenshot from 2019-06-07 15-39-58

Release Plan

This can be merged any time I believe, assuming consensus on the plan to allow breaking change in the minor version semver space


Think react-native-firebase is great? Please consider supporting the project with any of the below:

@mikehardy mikehardy requested a review from Salakar June 7, 2019 20:52
@invertase invertase deleted a comment from codecov bot Jun 9, 2019
@codecov
Copy link

codecov bot commented Jun 9, 2019

Codecov Report

❗ No coverage uploaded for pull request base (v5.x.x@c81a539). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             v5.x.x    #2214   +/-   ##
=========================================
  Coverage          ?   72.76%           
=========================================
  Files             ?       64           
  Lines             ?     1589           
  Branches          ?        0           
=========================================
  Hits              ?     1156           
  Misses            ?      433           
  Partials          ?        0

@codecov
Copy link

codecov bot commented Jun 9, 2019

Codecov Report

Merging #2214 into v5.x.x will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           v5.x.x    #2214   +/-   ##
=======================================
  Coverage   72.74%   72.74%           
=======================================
  Files          64       64           
  Lines        1599     1599           
=======================================
  Hits         1163     1163           
  Misses        436      436

@mikehardy
Copy link
Collaborator Author

The allow edits from maintainers thing is ticked, maybe something about the in-review flow doesn't allow commits? anyway I just accepted that wording change - looks good

Salakar
Salakar previously approved these changes Jun 9, 2019
@mikehardy
Copy link
Collaborator Author

I had to force-push to kick CI in the pants, but it's the same exact bits, and this is the last PR I wanted to push through right now, and I'll defer all the rest till after 5.4.3 so this will close the release. Can you approve me @Salakar :-) 🙏

@Salakar
Copy link
Contributor

Salakar commented Jun 11, 2019

We've lost the comment tweaks I did above previously =D

Salakar
Salakar previously approved these changes Jun 11, 2019
@mikehardy
Copy link
Collaborator Author

We've lost the comment tweaks I did above previously =D

well that's not okay! sorry about that. I re-changed it to match your suggestion

@mikehardy mikehardy requested a review from Salakar June 11, 2019 14:06
@mikehardy mikehardy merged commit f259a6e into invertase:v5.x.x Jun 11, 2019
@mikehardy mikehardy deleted the breaking-change-notice branch June 11, 2019 14:37
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.

2 participants