Permission | Access level | Purpose |
---|---|---|
Commit statuses | Read-only | Allows the GitHub app to read and update commit statuses, indicating whether a commit has passed checks (e.g., CI/CD pipelines). |
Contents | Read and write | Grants access to read and modify repository contents, including reading files, creating commits, and updating files. |
Issues | Read and write | Enables reading, creating, updating, closing, and commenting on issues within the repository. |
Merge queues | Read-only | Allows interaction with merge queues to manage the order of pull request merges. |
Metadata | Read-only | Provides read-only access to repository metadata, such as its name, description, and visibility. |
Pull requests | Read and write | Allows reading, creating, updating, merging, and commenting on pull requests. |
Permission | Access level | Purpose |
---|---|---|
Email addresses | Read-only | Grants access to users’ email addresses, typically for notifications or communication. |
Profile | Read and write | Enables access to user profile details like name, username, and avatar. |
Event | Purpose |
---|---|
Installation target | This is where the repositories or organizations where your GitHub App is installed. This determines which repositories Plane can sync with. |
Meta | Includes metadata about the app’s configuration and setup. This is essential for maintaining integration stability. |
Issue comment | Triggers when a comment is added, edited, or deleted on an issue. Useful for keeping comments synced between Plane and GitHub. |
Issues | Triggers when an issue is created, updated, closed, reopened, assigned, labeled, or transferred. Ensures issue status and details remain consistent between Plane and GitHub. |
Pull request | Fires when a pull request is opened, closed, merged, edited, or labeled. Essential for tracking development progress. |
Pull request review | Activates when a review is submitted, edited, or dismissed. Keeps review activities aligned between Plane and GitHub. |
Pull request review comment | Fires when a review comment is added, modified, or removed. Ensures feedback is reflected across both platforms. |
Pull request review thread | Triggers when a review discussion thread is resolved or reopened. Helps maintain visibility on code review discussions. |
Push | Activates when new commits are pushed to a repository. Useful for tracking code updates and changes. |
Repository sub issues | Tracks issues within a repository that are linked to or managed by another issue. Ensures accurate synchronization of related issues. |
.env
file.