Skip to content

Commit 9bc2d06

Browse files
s-santillankhorne3
andauthored
Sara/tec 294 docs add GitHub app installation and connection workflow (#1989)
* update instructions * callout * Update docs/deployment/connect-scm.md Co-authored-by: Katie Horne <[email protected]> * Update docs/deployment/connect-scm.md Co-authored-by: Katie Horne <[email protected]> * Update docs/deployment/connect-scm.md Co-authored-by: Katie Horne <[email protected]> * add headers * last feedback --------- Co-authored-by: Katie Horne <[email protected]>
1 parent 6457f30 commit 9bc2d06

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

docs/deployment/connect-scm.md

+26-14
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you opted to scan a GitHub or GitLab repository when you initially signed in,
5656
- The **Name of your Azure DevOps organization**
5757
- Your **Access token**. See [User personal access tokens](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate) for information on generating a token.
5858
2. Click **Connect** to save and proceed.
59-
3. The Azure DevOps organization is now listed under **Source Code managers**. Click **Test** to verify that the new integration is installed correctly.
59+
3. The Azure DevOps organization is now listed under **Source code managers**. Click **Test** to verify that the new connection is installed correctly.
6060

6161
</TabItem>
6262
<TabItem value='bitbucket-cloud'>
@@ -67,34 +67,46 @@ If you opted to scan a GitHub or GitLab repository when you initially signed in,
6767
1. Go to **<i class="fa-solid fa-gear"></i> Settings > Source code managers > Add > Bitbucket Cloud**.
6868
1. In the **Connect your Bitbucket Workspace** dialog box, provide:
6969
- The **Name of your Bitbucket Workspace**
70-
- Your **Access token**. Semgrep expects a [workspace-level access token](https://support.atlassian.com/bitbucket-cloud/docs/create-a-workspace-access-token/).
70+
- Your **Access token**. Semgrep requires a [workspace-level access token](https://support.atlassian.com/bitbucket-cloud/docs/create-a-workspace-access-token/).
7171
1. Click **Connect** to save and proceed.
72-
1. The Bitbucket project is now listed under **Source Code managers**. Click **Test** to verify that the new integration is installed correctly.
72+
1. The Bitbucket project is now listed under **Source code managers**. Click **Test** to verify that the new connection is installed correctly.
7373

7474
</TabItem>
7575
<TabItem value='github-cloud'>
7676

77+
### GitHub Cloud with GitHub SSO
78+
79+
These steps are for users that sign in to Semgrep through GitHub.
80+
7781
1. Sign in to [<i class="fas fa-external-link fa-xs"></i> Semgrep AppSec Platform](https://semgrep.dev/login).
7882
1. Optional: If you have created more than one Semgrep account, select the account you want to make a connection for by clicking on the **Navigation bar > Your account name > The account you want to connect**.<br />
7983
<img src="/docs/img/more-accounts-dropdown.png" height="350px" />
8084
1. From the **Navigation bar**, click **<i class="fa-solid fa-gear"></i> Settings > Source code managers**.
81-
1. Click **Connect to GitHub**.
85+
1. Click **Add > GitHub**.
8286
1. Review the permissions requested by Semgrep, then click **Continue**.
8387
1. Click the organization you want to install Semgrep on.
8488
1. Choose to authorize and install Semgrep for **<i class="fa-regular fa-circle-dot"></i> All repositories** or **<i class="fa-regular fa-circle-dot"></i> Only select repositories**.
8589
1. Click **Install and authorize**.
8690
1. After a successful link, you are signed out of Semgrep AppSec Platform automatically, as your credentials have changed after linking an organization.
8791
1. Sign back in to Semgrep AppSec Platform.
8892

89-
</TabItem>
93+
### GitHub Cloud with non-GitHub SSO
9094

91-
<!-- removed temporarily because we're using the "old flow"
92-
:::tip
93-
- Getting Assistant recommendations grants Semgrep **code access**.
94-
- **Leave PR comments** refers to Semgrep's capability to post findings to developers in PRs.
95-
:::
95+
These steps are for users that sign in to Semgrep through a **non-GitHub** SSO provider.
96+
97+
1. Navigate to the following link: [<i class="fas fa-external-link fa-xs"></i> Semgrep GitHub app](https://github.com/marketplace/semgrep-dev) and install the Semgrep GitHub app onto the GitHub org you want to connect to.
98+
1. Sign in to [<i class="fas fa-external-link fa-xs"></i> Semgrep AppSec Platform](https://semgrep.dev/login) using SSO.
99+
1. Optional: If you have created more than one Semgrep account, select the account you want to make a connection for by clicking on the **Navigation bar > Your account name > The account you want to connect**.<br />
100+
<img src="/docs/img/more-accounts-dropdown.png" height="350px" />
101+
1. From the **Navigation bar**, click **<i class="fa-solid fa-gear"></i> Settings > Source code managers**.
102+
1. Click **Add > GitHub**.
103+
1. In the **Name of your GitHub Organization** field, enter the slug of the org that the app was installed on in step 1. For example, if the GitHub URL of your org is `https://github.com/acme-corp`, then the slug is typically `acme-corp`.
104+
1. Leave the access token field empty.
105+
1. Click **Connect**.
106+
1. Your GitHub org is now listed under **Source Code managers**. Click **Test** to verify that the new connection is installed correctly.
107+
108+
</TabItem>
96109

97-
-->
98110

99111
<TabItem value='gitlab-cloud'>
100112

@@ -106,7 +118,7 @@ If you opted to scan a GitHub or GitLab repository when you initially signed in,
106118
1. Enter the personal access token generated into the **Access token** field.
107119
1. Enter your GitLab group's name into the **Name of your GitLab Group** field. If your repositories are organized in subgroups, you only need to provide the name of the top-level group.
108120
1. Optional, but recommended: if you have multiple GitLab groups in your GitLab account, create a source code manager per group. Repeat steps 1, 3-4 for each GitLab group.
109-
1. The GitLab groups are now listed under **Source code managers**. Click **Test** to verify that the new integration is configured correctly.
121+
1. The GitLab groups are now listed under **Source code managers**. Click **Test** to verify that the new connection is configured correctly.
110122

111123
You have successfully connected an org in Semgrep AppSec Platform with an organization in your source code management tool.
112124

@@ -135,7 +147,7 @@ You have successfully connected an org in Semgrep AppSec Platform with an organi
135147
- The **URL** to access your installation of Bitbucket Data Center
136148
- The **Access Token** that [grants Semgrep permission to communicate with your project](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html). Semgrep expects a [workspace-level access token](https://support.atlassian.com/bitbucket-cloud/docs/create-a-workspace-access-token/)
137149
2. Click **Connect** to save and proceed.
138-
3. The Bitbucket project is now listed under **Source code managers**. Click **Test** to verify that the new integration was installed correctly.
150+
3. The Bitbucket project is now listed under **Source code managers**. Click **Test** to verify that the new connection was installed correctly.
139151

140152
</TabItem>
141153
<TabItem value='github-enterprise'>
@@ -214,7 +226,7 @@ Connect Semgrep and GitLab Self-Managed accounts by creating a PAT and providing
214226
1. Enter your GLSM base URL into the **URL** field.
215227
1. Enter your GitLab group's name into the **Name of your GitLab Group** field. If your repositories are organized in subgroups, you only need to provide the name of the top-level group.
216228
1. If you have multiple GitLab groups in your GitLab account, you need to create a source code manager per group. Repeat steps 1, 3-5 for each GitLab group.
217-
1. The GitLab groups are now listed under **Source Code managers**. Click **Test** to verify that the new integration is installed correctly.
229+
1. The GitLab groups are now listed under **Source Code managers**. Click **Test** to verify that the new connection is installed correctly.
218230

219231
</TabItem>
220232
</Tabs>

0 commit comments

Comments
 (0)