Skip to content

Commit

Permalink
Add PR Requirement Checking (#145)
Browse files Browse the repository at this point in the history
* Add PR requirements to check for Jira and GitHub issue references

* Update with PR edit, and fix branch bug

* Docs(ci): Add documentation about PR requirement workflow
  • Loading branch information
kdvalin authored Jan 21, 2025
1 parent 1db4a10 commit 03e68e7
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/verify_pr_requirements.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Verify PR has JIRA ticket and issue number

on:
pull_request:
types:
- opened
- edited
branches:
- main

permissions:
contents: read
pull-requests: write # Need write to make comments

jobs:
pr_issue_jira:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
repository: redhat-performance/pr-requirements
path: pr-requirements
ref: v1.0.0
- uses: ./pr-requirements
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
jira_ticket: true
jira_project: RPOPC
jira_url: https://issues.redhat.com
4 changes: 4 additions & 0 deletions ci/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Workflows in this repository

## Verify PR has JIRA ticket and issue number
This workflow is designed to enforce requirements for PR descriptions. At bare minimum it requires the PR to mention a related issue and mention the Jira Ticket number. Both of these are required since Sync2Jira does not know how to associate a PR with a Jira Ticket from the originating GitHub issue.


## Update parent issue
The idea behind this workflow is to keep Jira tickets in sync with the current status of their GitHub issue. A flowchart for how this works can be seen below.

Expand Down

0 comments on commit 03e68e7

Please sign in to comment.