Skip to content

chore: create workflow for common commits#128

Merged
jland-redhat merged 1 commit intoopendatahub-io:mainfrom
jland-redhat:common-commits
Oct 6, 2025
Merged

chore: create workflow for common commits#128
jland-redhat merged 1 commit intoopendatahub-io:mainfrom
jland-redhat:common-commits

Conversation

@jland-redhat
Copy link
Copy Markdown
Contributor

@jland-redhat jland-redhat commented Oct 2, 2025

Creating PR to insure we are using Common Commits Format

Summary by CodeRabbit

  • Chores
    • Introduced an automated PR title validation workflow for pull requests.
    • Validates titles against conventional commit types and format.
    • Runs on PR open, edit, and synchronize events with a short timeout.
    • Provides actionable feedback on non-compliant titles.
    • Skips validation when PRs are labeled as draft or WIP.
    • No changes to the product experience or application behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

Adds a new GitHub Actions workflow to validate pull request titles (and optionally bodies) against semantic commit conventions on pull_request events. It configures allowed types, subject/body patterns, label-based ignores for draft/wip, and runs a single validation job on ubuntu-latest.

Changes

Cohort / File(s) Summary of changes
CI: PR Title Validation Workflow
\.github/workflows/pr-title-validation.yml
Introduces a workflow triggered on pull_request (opened, edited, synchronize). Single job validates PR title using amannn/action-semantic-pull-request with configured allowed types, subject/body patterns, label-based ignores (draft, wip), and 5-minute timeout.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant GH as GitHub (PR Event)
  participant WF as Workflow: PR Title Validation
  participant Job as Job: validate-pr-title
  participant Act as Action: semantic-pull-request

  Dev->>GH: Open/Edit/Synchronize PR
  GH-->>WF: Trigger workflow
  WF->>Job: Start on ubuntu-latest (timeout 5m)
  Job->>Job: actions/checkout
  Job->>Act: Validate title/body with config
  alt PR labeled draft/wip
    Act-->>Job: Skip validation (ignored by labels)
  else Not draft/wip
    Act-->>Job: Pass/Fail based on rules
  end
  Job-->>WF: Result
  WF-->>GH: Status on PR
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears at titles neat,
Hop hop—semantic checks complete!
Drafts may rest, but wip can wait,
The carrots say, “validate.”
With every PR, I stamp and cheer—
A tidy trail of commits here. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the addition of a new workflow chore to enforce a common commit format, which aligns with the main change of introducing a semantic commit/PR title validation workflow.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (1)
.github/workflows/pr-title-validation.yml (1)

18-20: Drop the checkout step to streamline the job.

This action reads PR metadata via the API and never touches the workspace, so actions/checkout just burns time. Removing it will shave seconds off every run.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af78c9e and 5c87d04.

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

@jland-redhat jland-redhat enabled auto-merge (squash) October 6, 2025 19:59
Copy link
Copy Markdown
Member

@nerdalert nerdalert left a comment

Choose a reason for hiding this comment

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

LGTM

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Oct 6, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jland-redhat, nerdalert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [jland-redhat,nerdalert]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jland-redhat jland-redhat disabled auto-merge October 6, 2025 20:09
@jland-redhat jland-redhat merged commit 18fb484 into opendatahub-io:main Oct 6, 2025
4 of 5 checks passed
SB159 pushed a commit to SB159/maas-billing that referenced this pull request Oct 15, 2025
Co-authored-by: Jamie Land <hokie10@gmail.com>
@jland-redhat jland-redhat deleted the common-commits branch December 23, 2025 15:55
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.

3 participants