diff options
| author | MikeBirnstiehl <michael.birnstiehl@sonarsource.com> | 2019-08-13 08:26:57 -0500 |
|---|---|---|
| committer | SonarTech <sonartech@sonarsource.com> | 2019-08-13 20:21:06 +0200 |
| commit | f0ebfe75ce1400a9eae6f6fed7847592d97f0648 (patch) | |
| tree | a839c0e3276b1b927d5b3a9fc2167b1ae6ebf1e6 /server/sonar-docs | |
| parent | bf2da219c0a3a3f01b3ff6a6672a7c3859c5f039 (diff) | |
| download | sonarqube-f0ebfe75ce1400a9eae6f6fed7847592d97f0648.tar.gz sonarqube-f0ebfe75ce1400a9eae6f6fed7847592d97f0648.zip | |
DOCS update GH integration headings to enable TOC
Diffstat (limited to 'server/sonar-docs')
| -rw-r--r-- | server/sonar-docs/src/pages/instance-administration/github-application.md | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/server/sonar-docs/src/pages/instance-administration/github-application.md b/server/sonar-docs/src/pages/instance-administration/github-application.md index cd73ab2e8f5..8841dc9861a 100644 --- a/server/sonar-docs/src/pages/instance-administration/github-application.md +++ b/server/sonar-docs/src/pages/instance-administration/github-application.md @@ -4,11 +4,9 @@ url: /instance-administration/github-application/ --- _GitHub Enterprise Integration is available as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._ -## Adding Pull Request Decoration to GitHub Checks - You can add Pull Request decoration to Checks in GitHub Enterprise by creating a GitHub Application, configuring your SonarQube instance, and installing the app in your organizations. -### Creating a GitHub Application +## Creating a GitHub Application Click [here](https://developer.github.com/apps/building-github-apps/creating-a-github-app/) for general instructions on creating a GitHub App. @@ -28,27 +26,27 @@ From the "Register new GitHub App" page, follow these steps to create your GitHu 4. Under "Where can this GitHub App be installed?," select **Any account**. 5. Click **Create GitHub App**. -### Generating and Setting Your Private Key +## Generating and Setting Your Private Key After creating your app, you'll be prompted with a link to "generate a private key" at the top of the page. Click the link to download your `.pem` private key file. You can also download your `.pem` file by scrolling down to "Private Key" and clicking **Generate Private Key**. After downloading your `.pem` file, you'll need to set your private key in SonarQube global settings by copying and pasting the content of your private key file into the text box at [**Administration > Pull Requests > GitHub > GitHub App private key**](/#sonarqube-admin#/admin/settings?category=pull_request/). -### Configuring Your SonarQube Instance +## Configuring Your SonarQube Instance You'll need to configure the following global settings in SonarQube. -#### Setting Your GitHub Enterprise Instance API URL +### Setting Your GitHub Enterprise Instance API URL Enter your GitHub Enterprise Instance API URL in the text box at [**Administration > Pull Requests > GitHub > GitHub API URL**](/#sonarqube-admin#/admin/settings?category=pull_request/). Your GitHub Enterprise instance API URL is formatted as follows: `https://<your-github-enterprise-address>/api/v3` -#### Setting Your App Name and ID +### Setting Your App Name and ID 1. Enter your app name in the text box at [**Administration > Pull Requests > GitHub > GitHub App name**](/#sonarqube-admin#/admin/settings?category=pull_request/). 2. Enter your app ID in the text box at [**Administration > Pull Requests > GitHub > GitHub App ID**](/#sonarqube-admin#/admin/settings?category=pull_request/). You can find your GitHub App ID on the app's settings page at `https://<your-github-enterprise>/settings/apps/<appname>`. -### Installing Your App +## Installing Your App To install your app in your organizations: |