Skip to content

Commit

Permalink
Update github-permissions.md (#5860)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?
<!---
-->
Existing documentation on how to accept/update new Github app permission
is lacking the visualisation for confused customers (me included!) to
find exactly where the Settings are and what they should see under
Applications.

I managed to navigate to the right spot, but I was not sure where should
I be seeing this 'accept permissions' and if I can even see it. I also
noticed a few customers checking their repository settings instead of
their account settings.

Hoping the images and clarification on steps will provide a clearer
understanding for the customers.

## Checklist
<!--
-->
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

---------

Co-authored-by: Mirna Wong <[email protected]>
  • Loading branch information
wusanny and mirnawong1 authored Jul 30, 2024
1 parent 3514253 commit ca2605f
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions website/docs/faqs/Git/github-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,41 @@ sidebar_label: "GitHub and dbt Cloud permissions error"

If you see the error `This account needs to accept the latest permissions for the dbt Cloud GitHub App` in dbt Cloud &mdash; this usually occurs when the permissions for the dbt Cloud GitHub App are out of date.

To solve this issue, you'll need to update the permissions for the dbt Cloud GitHub App in your GitHub account. Here's a couple of ways you can do it:
To solve this issue, you'll need to update the permissions for the dbt Cloud GitHub App in your GitHub account. This FAQ shares a couple of ways you can do it.

#### Update permissions
## Update permissions

A Github organization admin will need to update the permissions in GitHub for the dbt Cloud GitHub App. If you're not the admin, reach out to your organization admin to request this. Alternatively, try [disconecting your GitHub account](#disconect-github) in dbt Cloud.
A GitHub organization admin will need to update the permissions in GitHub for the dbt Cloud GitHub App. If you're not the admin, reach out to your organization admin to request this.

1. Navigate to your GitHub account. Click on the top right profile icon and then **Settings** (or personal if using a non-organization account).

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-settings.jpg" width="50%" title="Navigate to your GitHub account to configure your settings." />

2. Then go to **Integrations** and then select **Applications** to identify any necessary permission changes. Note that a GitHub repository admin may not see the same permission request.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-applications.jpg" width="80%" title="Navigate to Application settings to identify permission changes." />

3. Click on **Review request** and then click on the **Accept new permissions** button on the next page.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-review-request.jpg" width="80%" title="Grant access to the dbt Cloud app by accepting the new permissions." />

1. Go directly to GitHub to determine if any updated permissions are required.
2. In GitHub, go to your organization **Settings** (or personal if using a non-organization account).
3. Then navigate to **Applications** to identify any necessary permission changes.
For more info on GitHub permissions, refer to [access permissions](https://docs.github.com/en/get-started/learning-about-github/access-permissions-on-github).

#### Disconnect GitHub
Alternatively, try [disconecting your GitHub account](#disconect-github) in dbt Cloud, detailed in the following section.

## Disconnect GitHub

Disconnect the GitHub and dbt Cloud integration in dbt Cloud.

1. In dbt Cloud, go to **Account Settings**.
2. In **Projects**, select the project that's experiencing the issue.
2. In **Projects**, select the project experiencing the issue.
3. Click the repository link under **Repository**.
4. In the **Repository details** page, click **Edit**.
5. Click **Disconnect** to remove the GitHub integration.
6. Go back to your **Project details** page and reconnect your repository by clicking the **Configure Repository** link.
6. Return to your **Project details** page and reconnect your repository by clicking the **Configure Repository** link.
7. Configure your repository and click **Save**

<Lightbox src="/img/repository-details-faq.jpg" title="Disconnect your GitHub connection in the 'Repository details' page."/>
<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/repository-details-faq.jpg" title="Disconnect your GitHub connection in the 'Repository details' page."/>

## Support
If you've tried these workarounds and are still experiencing this behavior &mdash; reach out to the [dbt Support](mailto:[email protected]) team and we'll be happy to help!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ca2605f

Please sign in to comment.