Configuring GitHub organization
This guide walks you through the process of installing the nullplatform GitHub integration app. This integration enables nullplatform to operate repositories on your behalf, automating essential DevOps workflows.
Installation steps
- Go to the nullplatform GitHub integration app and click Install.
- Select the account or organization where you want to install the app.
- Choose the repositories you want nullplatform to access:
- All repositories: By specifying all repositories, we will be allowed not only to operate existing repositories but also create new ones.
Record your Installation ID
Once the installation is complete, you'll be provided with an Installation ID.
Make sure to record your Installation ID, as you'll need it later when configuring Providers in nullplatform.
Understanding required permissions
The nullplatform GitHub integration requires specific permissions to operate effectively.
- These permissions represent the minimum required for nullplatform’s functionality.
- The app follows the principle of least privilege, requesting only what is essential for its operation.
Here’s a breakdown of why each permission is necessary:
Repository permissions
| Permission | Access level | Purpose |
|---|---|---|
| Contents | Write | Push code changes or content, such as Docker images |
| Actions | Write | Allow the notification system to trigger GitHub Actions workflows |
| Secrets | Write | Configure repositories with the nullplatform API key |
| Administration | Write | Create repositories and manage repository settings |
Organization permissions
| Permission | Access level | Purpose |
|---|---|---|
| Administration | Read | Allow us to read the organization, enabling the creation of repositories at the organization level |
| Organization webhooks | Read & Write | Enables our system to receive organization-level webhook events for specific workflows (Note: This permission is deprecated but still used for legacy functionality) |
Next steps
After installation, use the Installation ID to configure Providers in nullplatform. This will establish the connection between your GitHub repositories and nullplatform's automation capabilities.
If you have any questions about the permissions or installation process, reach out to us for support.