Skip to content

build: Add github action for PR title validation VSCODE-642 #859

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.

Sign up for GitHub

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

Merged
nirinchev merged 4 commits into from
Oct 25, 2024
Merged

build: Add github action for PR title validation VSCODE-642 #859

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b10dd52
Add github action for PR title validation
nirinchev Oct 24, 2024
399564a
Use the correct ignore label
nirinchev Oct 24, 2024
461e620
Relax the JIRA regex
nirinchev Oct 25, 2024
b1df706
Don't enforce Jira ticket check for bot PRs
nirinchev Oct 25, 2024
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
22 changes: 22 additions & 0 deletions .github/workflows/check-pr-title.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: "Check PR Title"
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled, converted_to_draft, edited]

jobs:
check-pr-title:
name: Check PR Title
runs-on: ubuntu-latest
steps:
- name: Enforce conventional commit style
uses: realm/ci-actions/title-checker@main
with:
regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|ops){1}(\([\w\-\.]+\))?(!)?: .*'
error-hint: 'Invalid PR title. Make sure it follows the conventional commit specification (i.e. "<type>(<optional scope>): <description>") or add the no-title-validation label'
ignore-labels: 'no-jira-ticket'
- name: Enforce JIRA ticket in title
uses: realm/ci-actions/title-checker@main
with:
regex: 'VSCODE-[0-9]{1,5}$'
Copy link
Contributor

@gribnoysup gribnoysup Oct 24, 2024

Choose a reason for hiding this comment

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

It happens sometimes that we have tickets in one JIRA project that are touching multiple repos at the same time, should we extend this to allow all three (MONGOSH, COMPASS, VSCODE) or is the expectation now that we're supposed to open separate tickets when this happens?

Copy link
Contributor

@alenakhineika alenakhineika Oct 24, 2024

Choose a reason for hiding this comment

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

Yeah, I would vote for flexible behavior when no Jira tickets or multiple tickets are allowed.

Copy link
Contributor Author

@nirinchev nirinchev Oct 25, 2024

Choose a reason for hiding this comment

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

Fair enough. I've relaxed the regex to look for something that looks like a JIRA ticket - LMK if that makes sense to you. The exact values I've chosen are somewhat arbitrary - I chose them as {min(projectName.length) - 2, max(projectName.length) + 2}, but happy to tweak them.

Copy link
Contributor

@alenakhineika alenakhineika Oct 25, 2024

Choose a reason for hiding this comment

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

Dependabot PRs won't have a Jira ticket chore(deps): bump the driver group with 2 updates. Changelog PRs as well chore: update CHANGELOG.md. Sometimes there are PRs with one line change, e.g. spelling mistakes. Those don't even require approval to be merged, so I don't think a ticket is worth creating in these cases. Could we enforce Jira tickets for feat and fix prefixes only?

Copy link
Contributor Author

@nirinchev nirinchev Oct 25, 2024

Choose a reason for hiding this comment

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

Enforcing for particular prefix is not super easy, so I figured I'll just skip the Jira ticket check for bot PRs.

Copy link
Contributor

@alenakhineika alenakhineika Oct 25, 2024

Choose a reason for hiding this comment

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

What about tiny PRs that do not have a corresponding ticket?

Copy link
Contributor Author

@nirinchev nirinchev Oct 25, 2024

Choose a reason for hiding this comment

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

You can add the no-title-validation label (or just merge with the check failing).

error-hint: 'Invalid PR title. Make sure it ends with a JIRA ticket - i.e. VSCODE-1234 or add the no-title-validation label'
ignore-labels: 'no-title-validation'
Loading