miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
nx/docs/nx-cloud/enterprise/single-tenant/custom-github-app.md
Rares Matei 19b0828d27
docs(nx-cloud): mention webhook events (#28815) 
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-11-11 15:43:51 -05:00

2.5 KiB
Raw Blame History

Custom GitHub App

Before creating your container, you'll need to create a GitHub app for your organisation.

Creating a GitHub app

From GitHub, click on your profile picture and chose "Settings":

Step 1

Then "Developer settings" from the left-hand menu:

Step 2

Then "GitHub Apps":

Step 3

And create a new GitHub app:

Step 4

Give it a name, and a homepage URL. The callback URL is the important bit. It needs to be in this form:

[your-nx-cloud-url]/callbacks/github-user

# for example
https://my.nx-enterprise.url:8080/callbacks/github-user

Configure a webhook and give it a secret: (the URL needs to match https://<your-NxCloud-instance-URL>/nx-cloud/github-webhook-handler)

Step 5

Make sure you subscribe to the "Organization" events:

Step 5.1

Once you create the app, keep a note of the Client ID and App ID:

Step 6

Then generate a new client secret, and save it somewhere secure (we'll use it in a bit):

Step 7

Finally, scroll down and download a private key:

Step 7

Then navigate to your download location locally and stringify the contents of the private key:

awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' your-key.pem # keep a note of the output

Save the output of the above, as we'll also use it in a bit.

Configure Permissions for the GitHub App

The following permissions are required for Nx Cloud to work:

Repository permissions:

  • Contents: Read & Write
  • Pull requests: Read & Write
  • Checks: Read Only
  • Commit Statuses: Read & Write
  • Issues: Read & Write
  • Metadata: Read Only

Organization permissions:

  • Administration: Read Only
  • Members: Read Only

Connect Your Nx Cloud Installation

Provide the following values to your developer productivity engineer so they can help connect Nx Cloud to your custom GitHub app:

  • Github App Client ID
  • Github App Client Secret
  • Github App App ID
  • Github App Private Key
  • GitHub App Webhook Secret