Skip to main content

JIRA

Post a deployment comment and optionally update issue status and assignee.

Setup

  1. Create a JIRA API token.
  2. Add VORTEX_NOTIFY_JIRA_TOKEN to your hosting provider's environment variables.
  3. Add VORTEX_NOTIFY_JIRA_USER_EMAIL to your .env file.

Environment variables

VariableRequiredDefaultLocationDescription
VORTEX_NOTIFY_JIRA_TOKENYesHostingJIRA API token
VORTEX_NOTIFY_JIRA_USER_EMAILYes.envJIRA user email
VORTEX_NOTIFY_JIRA_PROJECTNoVORTEX_NOTIFY_PROJECT.envProject name
VORTEX_NOTIFY_JIRA_MESSAGENoDefault template.envCustom message template
VORTEX_NOTIFY_JIRA_ASSIGNEE_EMAILNo.envAssignee email after deployment
VORTEX_NOTIFY_JIRA_TRANSITIONNo.envTransition name (e.g., "In Review")
VORTEX_NOTIFY_JIRA_ENDPOINTNohttps://jira.atlassian.com.envJIRA API endpoint
VORTEX_NOTIFY_JIRA_BRANCHESNo.envRestrict to specific branches (comma-separated)

Issue key extraction

The notification system automatically extracts JIRA issue keys from the deployment label using the pattern [A-Za-z0-9]+-[0-9]+:

  • feature/PROJ-123-add-featurePROJ-123
  • feature/PRJ-456-fix-authPRJ-456