Skip to content

feat(ci): validate checklist is updated#636

Merged
Molter73 merged 5 commits into
mainfrom
mauro/ci/validate-checklist
May 11, 2026
Merged

feat(ci): validate checklist is updated#636
Molter73 merged 5 commits into
mainfrom
mauro/ci/validate-checklist

Conversation

@Molter73
Copy link
Copy Markdown
Contributor

@Molter73 Molter73 commented May 8, 2026

Description

This is a small CI check that verifies a few fields in the checklist section of the PR description is updated. If this is not too disruptive, we can probably make the check required in the near future.

Checklist

  • Patch has a change log entry OR does not need one
  • Investigated and inspected CI test results
  • Updated documentation accordingly

Automated testing

  • Added unit tests
  • Added integration tests
  • Added regression tests

If any of these don't apply, please comment below.

Testing Performed

  • Check is skipped for draft PRs: CI run.
  • Change log check fails when not set: CI run.
  • CI check fails when not set: CI run
  • Job passes when both entries are set: CI run
  • Marking the PR as ready for review triggers the check: CI run

@Molter73 Molter73 marked this pull request as ready for review May 8, 2026 10:05
@Molter73 Molter73 requested a review from a team as a code owner May 8, 2026 10:05
Base automatically changed from mauro/docs/add-changelog to main May 11, 2026 09:21
Copy link
Copy Markdown
Contributor

@Stringy Stringy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! might need to rebase though, since this has changes from #635

Molter73 added 4 commits May 11, 2026 11:33
This is a small CI check that verifies a few fields in the checklist
section of the PR description is updated. If this is not too disruptive,
we can probably make the check required in the near future.
@Molter73 Molter73 force-pushed the mauro/ci/validate-checklist branch from 69e6152 to 7ce78ec Compare May 11, 2026 09:33
@Molter73
Copy link
Copy Markdown
Contributor Author

@CodeRabbit review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces a GitHub Actions workflow that enforces required PR checklist items on pull requests. The workflow validates that PRs contain checked entries for changelog updates and CI test result inspection, with exemption logic for the red-hat-konflux[bot] actor.

Changes

PR Checklist Enforcement

Layer / File(s) Summary
Workflow Trigger
.github/workflows/pr-checklist.yml
Workflow triggers on PR open, edit, synchronize, and reopen events.
Job Configuration
.github/workflows/pr-checklist.yml
Job runs on ubuntu-24.04 and is gated to non-draft pull requests.
Checklist Validation
.github/workflows/pr-checklist.yml
Grep-based validation checks PR body for two required - [x] ... entries: changelog requirement and CI inspection requirement; workflow fails if either is missing.
Bot Exemption
.github/workflows/pr-checklist.yml
Conditional step exempts red-hat-konflux[bot] from enforcement and logs exemption message.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a CI validation check for PR checklist fields.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description is well-structured and comprehensive, following the template with all required sections filled out appropriately.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mauro/ci/validate-checklist

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/pr-checklist.yml:
- Around line 5-9: The pull_request event types list is missing the
ready_for_review transition so marking a draft PR as ready bypasses the
workflow; update the pull_request.types array in
.github/workflows/pr-checklist.yml (the block where types: includes opened,
edited, synchronize, reopened) to also include ready_for_review so the workflow
triggers when a draft is marked ready_for_review.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 6f7dfcb7-6a46-4234-a680-ef35bc3fa63b

📥 Commits

Reviewing files that changed from the base of the PR and between c8ffcd5 and 7ce78ec.

📒 Files selected for processing (1)
  • .github/workflows/pr-checklist.yml

Comment thread .github/workflows/pr-checklist.yml
@Molter73 Molter73 marked this pull request as draft May 11, 2026 09:42
@Molter73 Molter73 marked this pull request as ready for review May 11, 2026 09:43
@Molter73 Molter73 marked this pull request as draft May 11, 2026 09:44
@Molter73 Molter73 marked this pull request as ready for review May 11, 2026 09:48
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

CodeRabbit chat interactions are restricted to organization members for this repository. Ask an organization member to interact with CodeRabbit, or set chat.allow_non_org_members: true in your configuration.

@Molter73 Molter73 enabled auto-merge (squash) May 11, 2026 09:49
@Molter73 Molter73 merged commit 514b741 into main May 11, 2026
27 checks passed
@Molter73 Molter73 deleted the mauro/ci/validate-checklist branch May 11, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants