Delivering to GitHub

If you would like to fully integrate Supernova with your organization's GitHub account, you can grant Supernova access to any GitHub repository to create pull requests on your behalf. This is done by installing and authorizing the Supernova GitHub App.

If you prefer not to authorize access to a repository that contains production code, it is also possible to create a separate repository for Supernova-created data (to be used as a git submodule). This method eliminates any possibility for Supernova to access parts of the code not maintained by Supernova.

With the secure GitHub authentication, Supernova will have the following permissions:

• Read access to metadata
• Read and write access to code and pull requests

Authorize GitHub

To authorize GitHub from the Account → Profile Settings page:

1. Select the Integrations tab.
2. Under GitHub, click Sign in to sign in to your GitHub account.
3. Choose All repositories to give access to all of the repositories in your organization, or choose Select repositories to select which repositories Supernova will have access to.
4. Click Install & authorize to continue.

To authorize GitHub from the New build or New pipeline dialog:

1. Set Create pull requests option to ON.
2. Click Sign in to sign in to your GitHub account.
3. Choose All repositories to give access to all of the repositories in your organization, or Select repositories to select which repositories Supernova will have access to.
4. Click Install & authorize to continue.

After your GitHub authorization is complete, you will now see a list of repositories and branches to choose from during hook or build configuration.

Revoke GitHub authorization

To revoke your GitHub authorization at any time:

1. Go to your Account settings, located in the top right corner.
2. Select the Integrations tab.
3. Under the GitHub section, click Remove.

Choosing a repository and relative path

The repository you selected is where the code from a pipeline will be exported. You can also specify a relative path to export to for each pipeline separately.

The path entered is relative to the repository root, for example, lib/design-system/assets.

Create pull requests

When you create a new pipeline, you will most likely want to open pull requests in GitHub directly from Supernova. To automatically create pull requests with a pipeline:

1. On the Pipelines page, click + New to open the New pipeline dialog.
2. After defining your pipeline, set Create pull requests option to ON.
3. If you have not yet integrated with GitHub, follow steps above for 'Authorize GitHub integration'.
4. Optionally, choose a relative path for the export.
5. Click Confirm to save the pipeline.

Once the new pipeline has been created, it will appear in your list of hooks with the Create pull request step added.

If you would like to stop the pipeline from creating pull requests, you can click Disable in the list to temporarily disable it, or click Remove to delete the pipeline completely.