Skip to main content

GitHub

Post deployment status to GitHub pull requests.

Setup​

  1. Create a GitHub personal access token.
  2. Add VORTEX_NOTIFY_GITHUB_TOKEN to your hosting provider's environment variables.
  3. Add VORTEX_NOTIFY_GITHUB_REPOSITORY to your hosting provider's environment variables.

Environment variables​

VariableRequiredDefaultLocationDescription
VORTEX_NOTIFY_GITHUB_TOKENYesHostingGitHub personal access token
VORTEX_NOTIFY_GITHUB_REPOSITORYYesHostingRepository in owner/repo format
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_TYPENo${VORTEX_NOTIFY_LABEL}.envEnvironment name (defaults to label, e.g. PR-123)
VORTEX_NOTIFY_GITHUB_BRANCHESNo.envRestrict to specific branches (comma-separated)

Example​

The pull request page shows deployment status with a View deployment button to quickly access the deployed environment.

notification-github-after.png