Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/jira-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Validate JIRA Issue

on:
pull_request:

jobs:
validate:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- id: validate
uses: Boulevard/jira-check-action@main
with:
require_in_title: "false"
pr_title: ${{ github.event.pull_request.title }}
pr_body: ${{ github.event.pull_request.body }}
pr_author: ${{ github.event.pull_request.user.login }}
branch_name: ${{ github.event.pull_request.head.ref }}

- name: Post sticky comment on failure
if: steps.validate.outputs.validation_passed == 'false'
uses: marocchino/sticky-pull-request-comment@v2
with:
header: jira-validation
message: ${{ steps.validate.outputs.error_message }}

- name: Delete sticky comment on success
if: steps.validate.outputs.validation_passed == 'true'
uses: marocchino/sticky-pull-request-comment@v2
with:
header: jira-validation
delete: true

- name: Fail if invalid
if: steps.validate.outputs.validation_passed == 'false'
run: exit 1
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,21 @@ Pull requests are welcome. See the [contribution guidelines](https://github.com/
## Issues

If you encounter any problems while trying to run the starter kit please create an issue.

## JIRA Issue Validation

Our CI pipeline validates all PR titles and bodies to ensure they contain a valid JIRA issue reference.

A custom GitHub Action (`Boulevard/jira-check-action`) enforces this formatting standard and provides fast feedback in PRs.

### How it works

- Every pull request triggers the JIRA validation workflow.
- The workflow checks the PR title, description, author, and branch name.
- Sticky PR comments provide failure reasons.
- The PR cannot merge if validation fails.

### Expected JIRA formats

Examples of valid PR references:
PIE-456: Fix bug
Loading