Github dbt docs Sync

Connect your Github dbt repository directly in Select Star with the following steps

  1. Confirm the data source settings are as follows

    1. Create a separate Data Source is checked

    2. Sync dbt Documentation is checked

  1. Using the Github Configuration UI available in the Apps section, add the Github repo details.

  2. To ensure Select Star can access your Github Repo, install the Github app on your repository. Github App: Select Star dbt docs Sync

    Github App Required Permissions

    • Read access to metadata: This allows us to ensure we are syncing the descriptions to the updated models.

    • Read and write access to code and pull request: This allows us to create or delete a PR and verify that there are no conflicts when generating a PR.

  1. Provide the following information

  • Select Star Datasource - This dropdown will have a list of all your connected dbt Datasources

  • Github URL - Provide the Github Repository URL

  • Project Name - dbt Project name, as mentioned in the dbt_project.yml file, and

  • Path Prefix - Information about the Root folder (if the dbt project is not in the root folder)

Once this is setup, you will see new PRs generated in your Github Repo.

You will also be able to see the list of all the PRs created by this feature in the Select Star UI.

Last updated