Skip to main content

Community (open-source) Installation Guide

You can use either of the following methods to copy files from the Community GitHub repository to your Dataform repository.

1. Clone the Community repository and connect your Git repo to Dataform​

If you choose this route, you will be able to keep iterating on the existing models with a Git connection that you own. The downside is that you will have to update the repository yourself (if you want to) when we roll out new versions.

1. Run git clone locally:

git clone https://github.com/superformlabs/ga4dataform.git

2. Push the cloned files to a Git repository that you own 3. Connect your Git repository with Dataform

2. Connect your Dataform repository to the Community Github repo​

Connecting your Dataform repository to this Github repo (even just temporarily) is probably the least amount of effort to move all files and folders to your workspace. The downside is that you will have to disconnect Github if you want to add your own queries to the workspace.

Prerequisites​

  • Your project has billing enabled
  • You have proper permissions
  • Secret Manager API is enabled
  • Dataform service account has Secret Manager, Secret Accessor role

Steps​

  1. Navigate to Dataform
  2. Select the repository you want to connect
  3. Click on Settings
  4. Select HTTPS and paste in this link: https://github.com/superformlabs/ga4dataform-community.git
  5. Set your default branch to main
  6. Create a new secret with any name and value
  7. Click Link
  8. Create a new workspace (it will automatically pull in the files)
  9. Lastly, feel free to Delete Connection in the Settings tab