Skip to content

Commit

Permalink
docs(nx-cloud): misc vcs docs update (#18773)
Browse files Browse the repository at this point in the history
  • Loading branch information
nartc authored Aug 22, 2023
1 parent 9ffea2b commit 1c058de
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/nx-cloud/set-up/bitbucket-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ To use an app password for authentication, one must be generated with proper per
Once the app password is created, verify the username is correct, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.

{% callout type="note" title="Use the correct username" %}
Make sure that you are using your Bitbucket username, found on the [account settings](https://bitbucket.org/account/settings) screen, and not your email address.
Make sure that you are using your Bitbucket username, found on the [account settings](https://bitbucket.org/account/settings/) screen, and not your email address.
{% /callout %}
4 changes: 4 additions & 0 deletions docs/nx-cloud/set-up/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ To use a Personal Access Token for authentication, one must be generated with pr

Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the "_CI Platform Considerations_" section below, and if there are no additional instructions for your platform of choice, setup is complete.

### Advanced Configuration

If your company runs a self-hosted GitHub installation, you may need to override the default URL that Nx Cloud uses to connect to the GitHub API. To do so, check the box labeled "Override GitHub API URL" and enter the correct URL for your organization.

## CI Platform Considerations

If you are using CircleCI, TravisCI, GitHub Actions or GitHub, there is nothing else you need to do. If you are using other CI providers, you need to set the `NX_BRANCH` environment variable in your CI configuration. The variable has to be set to a PR number.
Expand Down

1 comment on commit 1c058de

@vercel
Copy link

@vercel vercel bot commented on 1c058de Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx.dev
nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx-dev-git-master-nrwl.vercel.app

Please sign in to comment.