Plugin: hook-jira
Updates Jira release metadata after SemRel publishes a version. It is useful for creating or updating fix versions and aligning Jira projects with shipped SemVer releases.
Installation
Section titled “Installation”Binary
Section titled “Binary”semrel plugin install @semrel/hook-jirasemrel plugin install downloads the binary to .semrel/plugins/ and updates .semrel.lock. Commit .semrel.lock to pin the version for your team.
Docker
Section titled “Docker”Pre-built, signed multi-platform images (linux/amd64, linux/arm64) are published on every release:
docker pull ghcr.io/semrels/hook-jira:latestVerify the image signature with cosign:
cosign verify ghcr.io/semrels/hook-jira:latest \ --certificate-identity-regexp 'https://github.com/SemRels/hook-jira/.github/workflows/release.yml.*' \ --certificate-oidc-issuer https://token.actions.githubusercontent.comConfiguration
Section titled “Configuration”version: 1plugins: - uses: @semrel/hook-jira args: base_url: 'https://jira.example.com' # token is read from SEMREL_PLUGIN_TOKEN env var project: SEMREL fix_version_template: '{{ .NextVersion }}'Environment Variables
Section titled “Environment Variables”| Name | Required | Default | Description |
|---|---|---|---|
SEMREL_PLUGIN_BASE_URL | yes | — | Base URL for the Jira instance. |
SEMREL_PLUGIN_TOKEN | yes | — | API token for Jira authentication. |
SEMREL_PLUGIN_PROJECT | yes | — | Jira project key. |
SEMREL_PLUGIN_FIX_VERSION_TEMPLATE | no | plugin-defined | Template used to name the Jira fix version. |
Release Context Variables
Section titled “Release Context Variables”SEMREL_TAG_NAMESEMREL_NEXT_VERSIONSEMREL_CURRENT_VERSIONSEMREL_BUMPSEMREL_BRANCHSEMREL_CHANGELOGSEMREL_DRY_RUN
Behavior
Section titled “Behavior”With fix_version_template: '{{ .NextVersion }}', a release to v1.4.0 can create or update the Jira fix version 1.4.0 in the configured project.