Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.5 KB

working-with-git-secret.md

File metadata and controls

36 lines (25 loc) · 1.5 KB
Raw

Working with project secrets

Official pulse.eco secrets

In order to protect API key configuration used in this project from abuse by malicious third party, they are protected by encryption using git-secret, read more on git-secret.

  1. Install git-secret. If you are using Windows, try using Windows Sybsystem for Linux.
brew install git-secret
  1. Follow instructions on git-secret.io on how to create RSA key-pair for GPG
  2. Once exported, store your key-pair somewhere safe (Example: password manager, cloud storage)
  3. Share your public key (public-key.gpg) with some of the maintainers on pulse.eco Slack.
    • Mainteiner: follow instructions how to perform git-secret tell.
  4. After maintainer has confirmed that you have been told the secret, git pull latest changes (make sure on correct branch).
  5. To decrypt/reveal the secrete in the project.
git-secret reveal
  1. If everyting worked correctly, you should have all the things needed to build the project.

Using your own secrets

If if don't want to know the official secrets or you are not eligible to know them, you can still setup the project with you own secrets.

Files that need to be generated by you:

buildSrc/src/main/java/ProjectSecrets.kt
app/google-services.json

Instructions what they need to contain, coming soon. If eager to try out, ping on our Slack, you will be guided.