Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR Requirement Checking #145

Merged
merged 4 commits into from
Jan 21, 2025
Merged
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
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
Loading