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

docs(remote-config)!: update docs to be explicit about new behavior #4169

Merged
merged 1 commit into from
Aug 28, 2020

Conversation

mikehardy
Copy link
Collaborator

@mikehardy mikehardy commented Aug 28, 2020

A commit just to get a breaking change notice in the commit log for auto-population on semantic release.

Related #4157


BREAKING CHANGE:

    fetchAndActivate
        Previous behaviour returned a boolean indicating if config values were activated
        New behaviour returns a boolean indicating if any config values were fetched remotely.

    activate
        Previous behaviour returned a boolean indicating if config values were activated
        New behaviour returns a boolean indicating if any local config values were activated.

Description

Related issues

Release Summary

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan


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

@vercel
Copy link

vercel bot commented Aug 28, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/invertase/react-native-firebase/98p7tr1ob
✅ Preview: https://react-native-firebase-git-remote-config-breaking-change-commit.invertase.vercel.app

@mikehardy mikehardy requested a review from Salakar August 28, 2020 20:11
BREAKING CHANGE:

    fetchAndActivate
        Previous behaviour returned a boolean indicating if config values were activated
        New behaviour returns a boolean indicating if any config values were fetched remotely.

    activate
        Previous behaviour returned a boolean indicating if config values were activated
        New behaviour returns a boolean indicating if any local config values were activated.
@mikehardy mikehardy added the Workflow: Pending Merge Waiting on CI or similar label Aug 28, 2020
@mikehardy mikehardy merged commit 02527a0 into master Aug 28, 2020
@mikehardy mikehardy deleted the remote-config-breaking-change-commit branch August 28, 2020 20:52
@mikehardy mikehardy removed the Workflow: Pending Merge Waiting on CI or similar label Aug 28, 2020
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