Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.78 KB

SETUP.md

File metadata and controls

26 lines (21 loc) · 1.78 KB
Raw

Setup

Certain one-time setups need to be done for this repo to function as expected. At the time of writing, this has already been done. However, instructions are provided here for transparency and reproducibility in the event that any part of the setup needs to be repeated later.

GitHub Authentication

  1. Generate a fine-grained personal access token with the name cdfe-icc-eval-core and read-only access to public repos only.
  2. (For running the pipeline locally) In /data/.env.local, add a AUTH_GITHUB key with the value of the generated token, e.g. AUTH_GITHUB=github_pat_12345
  3. (For running the pipeline on GitHub Actions) Create an actions repository secret in this repo with the name AUTH_GITHUB and value of the generated token.

Google Analytics authentication

  1. Go to the Google Console welcome page (console.cloud.google.com).
  2. Create a new project titled "cfde-icc-eval-core".
  3. Go to "IAM & Admin".
  4. Create a service account with name "API Access" and id "api-access".
  5. Create a JSON key for the service account.
  6. (For running the pipeline locally) Download the JSON key, move it to the root of this repo, rename it to "ga-credentials.json", and ensure it is being picked up by .gitignore.
  7. Go back to the Google Console welcome page, then to "API & Services".
  8. Disable any apis (one-by-one) that were enabled by default.
  9. Enable "Google Analytics Data API" and "Google Analytics Admin API".
  10. Find the service account email in the Google Console dashboard or in the JSON key.
  11. In the Google Analytics instructions of this repo's readme, update the email account that submitters need to grant access to.
  12. (For running the pipeline on GitHub Actions) Create an actions repository secret in this repo with the name AUTH_GOOGLE and value of the JSON key file contents.