From 03e68e73874b727c64d3255601460563e767b7d3 Mon Sep 17 00:00:00 2001
From: Keith Valin <keith@mailtux.net>
Date: Tue, 21 Jan 2025 14:21:56 -0500
Subject: [PATCH] Add PR Requirement Checking (#145)

* 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
---
 .github/workflows/verify_pr_requirements.yaml | 29 +++++++++++++++++++
 ci/README.md                                  |  4 +++
 2 files changed, 33 insertions(+)
 create mode 100644 .github/workflows/verify_pr_requirements.yaml

diff --git a/.github/workflows/verify_pr_requirements.yaml b/.github/workflows/verify_pr_requirements.yaml
new file mode 100644
index 0000000..2538153
--- /dev/null
+++ b/.github/workflows/verify_pr_requirements.yaml
@@ -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
\ No newline at end of file
diff --git a/ci/README.md b/ci/README.md
index 3bab370..f5127c2 100644
--- a/ci/README.md
+++ b/ci/README.md
@@ -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.