Code repositories
Github
Elementary connects to the code repository where your dbt project code is managed, and opens PRs with configuration changes.
Recommended: Connect using Elementary Github App
Navigate to the Account settings > Environments and choose the environment to which you would like to connect the dbt project code repository. Simply Click the blue button that says “Connect with Elementary Github App” and follow the instructions. In the menu that opens up later on, select the repository where your dbt project is stored, and if needed the branch and path to the dbt project.Requires a user with permissions to install new applications in the repository.
Alternative: Create a Github fine-grained token
If connecting the Elementary Github App isn’t an option, you can connect to Github using a fine-grained token managed by your team instead.Token creation and permissions
Token creation and permissions
- In the upper-right corner of any page, click your profile photo, then click Settings.
- On the bottom of the left sidebar, click Developer settings.
- On the left sidebar, select Personal access tokens > Fine-grained tokens.
- Click Generate new token.
- Enter a token name, expiration (we recommend 90 days) and description.
- Under Resource owner select the owner of the dbt project repo. If it is missing, you need to contact the resource owner administrator and ask him to approve fine-grained personal access tokens. Read more in For more information, see “Setting a personal access token policy for your organization”.
- Under Repository access select Only selected repositories and select the repo of your dbt project (see picture).
Github token - select dbt project repository
- Under Permissions, grant the following scopes:
- Pull Requests (read and write)
- Contents (read and write)
Github token - required permissions
- Click Generate token.
Repository connection settings
After the authentication, you need to fill in the following details:- Repository - The full name of the code repo.
- Optional Environment base branch - If you want Elementary to open PRs in a target branch different than default, detail the branch name here.
- Optional Project path - If your dbt project isn't on the root directory of the repo, detail it's path here.
- Optional Update token - When the github token expires, regenerate a fine-grained token and paste it here.
Github connection to Elementary