Deploy directly from your GitHub repositories by installing the Miget GitHub App. Once connected, you can select a repository and branch, enable auto-deploy on push, and manage everything from the Miget dashboard.

​
Prerequisites

  • A Miget account with a Workspace
  • A GitHub account with access to the repositories you want to deploy

​
Install the GitHub App

1

Open Git Credentials

Navigate to your Workspace Settings and select the Git Credentials tab. Click Connect GitHub to begin the installation.
Workspace Settings showing Git Credentials with Connect GitHub button
For team environments, the GitHub App integration is recommended over Personal Access Tokens because it provides organization-level credentials and granular permissions.
2

Install Miget.com on GitHub

You are redirected to GitHub to install the Miget.com App. Choose where to install it:
GitHub App installation prompt for Miget.com
3

Select repositories and permissions

Choose which repositories Miget can access:
  • All repositories - grants access to all current and future repositories
  • Only select repositories - pick specific repositories to connect
Review the permissions and click Install.
GitHub App repository selection and permissions for Miget.com
The GitHub App requests:
  • Read access to code and metadata
  • Read and write access to pull requests and repository hooks

​
Deploy from GitHub

Once the GitHub App is installed, you can deploy from GitHub when creating a new application or changing an existing app’s deployment source.
1

Select GitHub as the source

In the New Application wizard, select the GitHub source type. Your connected repositories appear in a searchable list. Select the repository you want to deploy.
New Application source selection showing GitHub repositories
If you don’t see your repository, add more GitHub credentials or update your existing ones in Workspace Settings.
2

Choose a branch and enable auto-deploy

Select the branch to deploy from. You can also enable Auto-Deploy to automatically deploy your application whenever code is pushed to the selected branch.
Branch selection dropdown with auto-deploy toggle

​
Preview Environments

Preview Environments automatically create live application instances for every pull request, letting your team preview changes before merging. Each preview environment is a full clone of your application with its own URL.

​
Enabling Preview Environments

  1. Open your application in the Miget dashboard
  2. Go to Settings and find the Preview Environments section
  3. Enable preview environments and configure the trigger mode

​
Trigger Modes

Choose when preview environments are created:
ModeBehavior
AutoA preview environment is created for every pull request automatically
LabelA preview environment is created only when the review-app label is added to the PR
Branch patternA preview environment is created for PRs from branches matching a pattern (e.g., feature/*)

​
Cleanup Policies

Configure how preview environments are removed when they are no longer needed:
  • Immediate - the preview environment is deleted as soon as the PR is closed or merged
  • Retention days - the preview environment is kept for a specified number of days after the PR is closed
  • Inactivity - the preview environment is deleted after a period of inactivity

​
PR Status Comments

When a preview environment is deployed, Miget automatically posts a comment on the GitHub pull request with:
  • The deployment status (building, deployed, failed)
  • A direct link to the preview environment URL
This keeps your team informed without leaving GitHub.

​
Next Steps

Build Methods

Configure how your application is built

Environment Variables

Set secrets and configuration for your deployments