Skip to content

Commit

Permalink
Add GHA that enforces labeling and linking in PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
jhiemstrawisc committed Nov 27, 2024
1 parent 8e5f60a commit 37b41e2
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/enforce-PR-labelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: PR and Issue Validation

on:
pull_request:
# one limitation here is that there's no trigger to re-run any time we "connect" or "disconnect" an issue
types: [opened, edited, labeled, unlabeled, synchronize]

jobs:
validate-pr:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v2

- name: Validate PR has labels
id: check_labels
run: |
PR_LABELS=$(jq -r '.pull_request.labels | length' $GITHUB_EVENT_PATH)
if [ "$PR_LABELS" -eq "0" ]; then
echo "No labels found on the pull request."
exit 1
fi
- name: Validate PR is linked to an issue
id: check_linked_issues
run: |
PR_NUMBER=$(jq -r '.pull_request.number' $GITHUB_EVENT_PATH)
REPO_OWNER=$(jq -r '.repository.owner.login' $GITHUB_EVENT_PATH)
REPO_NAME=$(jq -r '.repository.name' $GITHUB_EVENT_PATH)
TIMELINE_JSON=$(curl -s "https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/issues/$PR_NUMBER/timeline")
# Count the number of times the timeline sees a "connected" event and subract the number of "disconnected" events
# We might also consider using the "cross-referenced" event in the future if actual connecting/disconnecting is too heavy-handed
LINKED_ISSUES=$(echo "$TIMELINE_JSON" | jq '
reduce .[] as $event (
0;
if $event.event == "connected" then
. + 1
elif $event.event == "disconnected" then
. - 1
else
.
end
)')
# If the sum is 0, then no linked issues were found
if [ "$LINKED_ISSUES" -eq "0" ]; then
echo "❌ No linked issues found in the pull request."
exit 1
elif [ "$LINKED_ISSUES" -lt "0" ]; then
echo "Error: More disconnected events than connected events. This shouldn't be possible and likely indicates a big ol' 🪲"
exit 1
else
echo "Linked issues found: $LINKED_ISSUES"
fi

0 comments on commit 37b41e2

Please sign in to comment.