Docs
Connecting providers
Connect GitHub, Bitbucket or GitLab in one click or with a scoped access token, and what each path needs.
Every available provider offers two ways to connect, and you can switch a token connection to one-click later without losing your tracked repositories. One difference: on GitHub, the one-click App opens promote approvals from green stage builds instantly. Otherwise DeployNX checks every 30 minutes by default (owners and admins set your organization’s interval in Settings › General), and Check now on Releases › Promoting looks right away. On every provider, DeployNX only looks for green stage builds on repositories with Auto-detect green stage builds turned on in their Stage → prod promote settings.
| Provider | One click | Token |
|---|---|---|
| GitHub | Install the DeployNX GitHub App | Fine-grained or classic personal access token |
| Bitbucket Cloud | Authorize DeployNX on your workspace | API token with your Atlassian email, or a workspace or repository access token |
| GitLab | Authorize DeployNX on GitLab.com, or on your self-managed instance | Personal, group or project access token (GitLab.com or self-managed) |
Tokens are encrypted at rest. One-click connections refresh their own access, even when unused for months, and DeployNX warns you 14 days and 3 days before a pasted token expires.
Connected the wrong organization, workspace or group, or moved to a new one? On Settings › Integrations › Git, each connected account offers Switch account: DeployNX connects the account you pick next and only then disconnects the old one, so a cancelled or refused connection changes nothing. Add another connects a second organization, workspace or group alongside. On GitHub, Switch to one-click and Reconnect take the existing connection’s place rather than counting as a new connection against your plan.
GitHub
One click. Choose Connect GitHub, pick the account or organization, and select the repositories DeployNX may see. The app asks for:
- Contents: read
- Metadata: read
- Actions: read and write (to run workflows and read logs)
- Deployments: read and write
- Pull requests: read
- Checks: read
Already installed the app on GitHub, from GitHub’s own app page or for an earlier connection? GitHub only offers Configure for an account that has it, so choose Already installed on GitHub? Connect it instead: DeployNX connects each installation on an account you own that no other DeployNX organization uses. An install started on GitHub brings you back to DeployNX with Finish connecting.
It also asks to act on your behalf, so that when you approve a production release DeployNX can release the GitHub environment: gate as you. This needs two things: the approver is a required reviewer on that GitHub environment, and the approver has authorized the DeployNX GitHub App. With both in place, your team approves once, in DeployNX.
Token. A classic token needs the repo and workflow scopes. For a fine-grained token, grant the same permissions as the app on the repositories you want to track. DeployNX shows any missing permission before you save.
Bitbucket
One click. Choose Connect Bitbucket and approve access to your workspace. DeployNX asks for account, repository, pull request, pipeline (read and write), webhook and project access.
Token. Use an Atlassian API token together with your Atlassian account email, or a workspace or repository access token with repository and pipeline permissions.
Stage builds. Turn on Auto-detect green stage builds in the repository’s Stage → prod promote settings. Green Bitbucket stage builds then open promote approvals automatically, checked every 30 minutes unless your organization sets another interval. Check now on Releases › Promoting looks right away.
GitLab
One click. Choose Connect GitLab and approve access on GitLab.com. DeployNX asks for the api and read_user scopes.
One click on a self-managed instance. DeployNX’s own GitLab application lives on GitLab.com, so your instance needs one of its own. Choose Self-managed GitLab? Connect your instance: it shows the redirect URI to register. On your GitLab, add an application under Admin › Applications (or a group’s Settings › Applications) with that redirect URI, Confidential on and the api and read_user scopes. Paste its Application ID and Secret, then Save and connect. DeployNX checks your instance accepts the application before it keeps it, and only reaches instances on a public address. Every group you can run pipelines in is connected, and the connection refreshes its own access. Self-managed instances are on the Hyperscale plan.
Token. Use a personal, group or project access token with the api and read_user scopes. For a self-managed instance, enter its base URL first; DeployNX checks that the address is reachable and public before it connects.
GitLab supports test runs, pipeline runs, deploys, rollbacks and stage-build detection.
Stage builds. Turn on Auto-detect green stage builds in the repository’s Stage → prod promote settings. Green GitLab stage builds then open promote approvals automatically, checked every 30 minutes unless your organization sets another interval. Check now on Releases › Promoting looks right away. GitLab has no webhook for this, so a one-click connection works the same way. DeployNX reads the newest successful push pipeline on the default branch. In the same settings you can narrow it to one pipeline by its workflow:name, and name the stage deploy job and the health job so DeployNX checks that both passed before it opens the approval. Approving runs a pipeline on the default branch with DEPLOY_ENV=prod, RELEASE_TAG=main_<first 12 characters of the commit SHA> and REBUILD=false, so a pipeline that tagged its stage image that way can deploy it instead of building again.
DeployNX doesn’t release GitLab protected-environment approvals. If your production job deploys to a protected environment that requires approval, someone still approves it in GitLab.
Other providers
More code hosts (such as Azure DevOps and GitHub Enterprise Server) and CI systems (such as Jenkins) are on the roadmap; Integrations lists every one. Tell us which one you need from the contact form.