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 gdrive sync credentials #2556

Merged
merged 5 commits into from
Nov 28, 2024
Merged

Conversation

chrismclarke
Copy link
Member

@chrismclarke chrismclarke commented Nov 26, 2024

PR Checklist

  • PR title descriptive (can be used in release notes)

Description

Following #2544

  • remove dev credentials from gdrive-tools package
  • remove encrypted credentials from scripts/config package
  • remove scripts used to decrypt config credentials
  • update main readme

Author Notes

In order to sync content from google drive a special credentials.json file is required to authorize the platform to act on behalf of users. This file is sensitive so we had previously kept it encrypted in the repo, and provided users with a private.key file used to decrypt (different from the deployment private keys), and instructed to run yarn scripts config decrypt command.

This PR completely removes the encrypted config (google service terms prohibits doing this), so now instead whenever onboarding a new developer they will need to be provided with the credentials.json file directly (instead of private key used to decrypt). This file will need to be re-shared any time the credentials are revoked and recreated (shouldn't be too often)

Existing users should be able to continue syncing with their previously decrypted credentials (local copy remains), unless it's decided to replace these (would require notifying all developers)

Dev Notes

I don't think the dev credentials were ever actually in use (platform seems to default to credentials in the scripts/config workspace). Once merged should be able to safely remove the dev credentials from cloud console (believe its in the plh-teens-app1 project). We may also want to consider rotating the other credentials

Git Issues

Closes #

Screenshots/Videos

Example - error message observed if credentials are not available
image

@github-actions github-actions bot added the maintenance Core updates, refactoring and code quality improvements label Nov 26, 2024
@chrismclarke chrismclarke mentioned this pull request Nov 26, 2024
1 task
@chrismclarke chrismclarke changed the title chore: remove dev credentials chore: remove gdrive sync credentials Nov 26, 2024
@chrismclarke chrismclarke marked this pull request as draft November 26, 2024 17:11
@chrismclarke
Copy link
Member Author

(updating to also remove config scripts credentials)

@github-actions github-actions bot added documentation Improvements or additions to documentation scripts Work on backend scripts and devops labels Nov 26, 2024
@chrismclarke chrismclarke marked this pull request as ready for review November 26, 2024 17:36
@github-actions github-actions bot added maintenance Core updates, refactoring and code quality improvements and removed maintenance Core updates, refactoring and code quality improvements documentation Improvements or additions to documentation labels Nov 26, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 28, 2024
@chrismclarke
Copy link
Member Author

chrismclarke commented Nov 28, 2024

@jfmcquade - would be good to get this merged if we can as I can see Ian has already emailed out new credential instructions so would be good to have the readme updated and decrypt workflow removed

Copy link
Collaborator

@jfmcquade jfmcquade left a comment

Choose a reason for hiding this comment

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

Makes sense and looks good

@jfmcquade jfmcquade merged commit f7f5e6d into master Nov 28, 2024
7 checks passed
@jfmcquade jfmcquade deleted the chore/remove-dev-credentials branch November 28, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Core updates, refactoring and code quality improvements scripts Work on backend scripts and devops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants