Github Version Control Integration Overview
minware can integrate with GitHub as a source of version control data.
Integration Methods
GitHub Application
The preferred method of integrating with GitHub cloud is using the minware marketplace application. To install the GitHub application in your GitHub organization, please visit Settings > Integrations in minware and click on the "GitHub" button under code sources. You will need administrative permissions to install the application.
GitHub App Permissions
Using minware's GitHub App is the recommended approach to integrating with GitHub. The app requests the following read-only permissions to provide the most complete minware experience:
Repository Permission
- Actions
- Contents
- Deployments
- Discussions
- Environments
- Issues
- Metadata (mandatory)
- Projects
- Pull requests
Organization Permissions
- GitHub Copilot Business
- Issue Types
- Members
- Projects
Personal Access Token
If you'd like to use a personal access token (e.g., if you don't have permission to install the GitHub application), visit Settings > Integrations in minware, click on the "GitHub" button under code sources, and follow the on-screen instructions.
The documentation below describes the permissions which provide the most complete minware experience.
Fine-grained Personal Access Token
Note: The required permissions are read-only for the fine-grained PAT.
Repository permissions
- Actions
- Contents
- Deployments
- Discussions
- Environments
- Issues
- Metadata
- Projects
- Pull requests
Organization permissions
- GitHub Copilot Business
- Issue types
- Members
- Organization projects
Setup Instructions (for github.com)
- Go to GitHub Settings → Developer settings → Personal access tokens → Fine-grained tokens
- Click "Generate new token"
- Set expiration as needed
- Select the organization
- Choose "All repositories" or select specific repositories
- Under "Repository permissions", set the permissions listed above to "Read"
- Under "Organization permissions", set the permissions listed above to "Read"
- Generate the token
Classic Personal Access Token
Repository scopes:
repo(Full control of private repositories)- This includes: repo:status, repo_deployment, public_repo, repo:invite
read:org(Read org and team membership, read org projects)read:project(Read access to user and organization projects)read:discussion(Read access to discussions)
Note: Classic PATs don't have granular read-only permissions for repositories, so repo gives more access than the GitHub App has.
Setup Instructions (for github.com)
- Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
- Click "Generate new token"
- Select scopes:
repo,read:org,read:project,read:discussion - Generate the token
GitHub Enterprise
To configure an on-premise GitHub Enterprise instance, visit Settings > Integrations in minware, click on the "GitHub" button under code sources, and follow the on-screen instructions.
Try minware today
