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

chore: Remove GoogleService files from git cache #12237

Merged
merged 2 commits into from
Nov 12, 2024

Conversation

gambinish
Copy link
Contributor

Description

Even though they are gitignore, ios/GoogleService-Info.plist and ios/GoogleServices/GoogleService-Info.plist were cached before they got added. So, they would not be ignored correctly by the gitignore.

This PR is the result of:

git rm --cached ios/GoogleServices/GoogleService-Info.plist
git rm --cached ios/GoogleService-Info.plist

Tested locally and it seems to work as we need it to. Can you please also verify when reviewing?

Related issues

Fixes:

Manual testing steps

  1. Remove existing GoogleServices files from your local
  2. yarn && yarn setup
  3. yarn start:ios

You will see the new files get generated: GoogleService-Info.plist has been created successfully.
They should no longer be tracked in git: git status

Screenshots/Recordings

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@gambinish gambinish marked this pull request as ready for review November 7, 2024 23:15
@gambinish gambinish requested a review from a team as a code owner November 7, 2024 23:15
Copy link
Contributor

github-actions bot commented Nov 7, 2024

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@gambinish gambinish changed the title chore: Remove GoogleService files from git cache so they can be gitig… chore: Remove GoogleService files from git cache Nov 7, 2024
@gambinish gambinish added the No QA Needed Apply this label when your PR does not need any QA effort. label Nov 7, 2024
@owencraston
Copy link
Contributor

I am worried about how removing this will effect the external contributor experience. Here is a snippet from the readme...

Before running the app, keep in mind that MetaMask uses FCM (Firebase Cloud Message) to empower communications. Based on this, as an external contributor you would preferably need to provide your own FREE Firebase project config file with a matching client for package name io.metamask, and update your google-services.json file in the android/app or GoogleService-Info.plist file in the ios directory.

External Contributors In case you don't have FCM account, you can use ./android/app/google-services-example.json for Android or ./ios/GoogleServices/GoogleService-Info-example.plist for iOS and follow the steps below to populate the correct environment variables in the .env files (.ios.env, .js.env, .android.env), adding GOOGLE_SERVICES_B64_ANDROID or GOOGLE_SERVICES_B64_IOS variable depending on the environment you are running the app (ios/android).

Perhaps we should move these into an example file or add the suffix.example and modify the readme instructions to instruct users to copy over these files in the correct paths. Alternatively if we are confident that the yarn:start:ios will generate this file for us then we can ommit this change.

@gambinish
Copy link
Contributor Author

Perhaps we should move these into an example file or add the suffix.example and modify the readme instructions to instruct users to copy over these files in the correct paths. Alternatively if we are confident that the yarn:start:ios will generate this file for us then we can ommit this change.

I've never had to copy these files, and have been relying purely on the yarn start:ios script to do everything. Have you been copying the files every time?

Copy link

sonarcloud bot commented Nov 9, 2024

Copy link
Contributor

@owencraston owencraston left a comment

Choose a reason for hiding this comment

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

Confirmed that removing the GoogleService-Info.plist from git cache stops them from being tracked by git. The readme changes look good but since we still have the example files in the code base (I did not realize this before I made my last comment) I think its okay to revert your changes to the readme.

@gambinish gambinish added this pull request to the merge queue Nov 12, 2024
Merged via the queue into main with commit 48fb8e1 Nov 12, 2024
37 checks passed
@gambinish gambinish deleted the fix-google-service-git-cache branch November 12, 2024 17:07
@github-actions github-actions bot locked and limited conversation to collaborators Nov 12, 2024
@gauthierpetetin gauthierpetetin added the release-7.36.0 Issue or pull request that will be included in release 7.36.0 label Nov 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
No QA Needed Apply this label when your PR does not need any QA effort. release-7.36.0 Issue or pull request that will be included in release 7.36.0 team-assets
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants