Skip to content

{CI} Add Verify PR title check#9750

Open
khang-11 wants to merge 1 commit intoAzure:mainfrom
khang-11:verify-pr-title-gha
Open

{CI} Add Verify PR title check#9750
khang-11 wants to merge 1 commit intoAzure:mainfrom
khang-11:verify-pr-title-gha

Conversation

@khang-11
Copy link
Copy Markdown

@khang-11 khang-11 commented Apr 1, 2026


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

For new extensions:

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

Copilot AI review requested due to automatic review settings April 1, 2026 05:04
@azure-client-tools-bot-prd
Copy link
Copy Markdown

Validation for Breaking Change Starting...

Thanks for your contribution!

@azure-client-tools-bot-prd
Copy link
Copy Markdown

Hi @khang-11,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Apr 1, 2026

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@khang-11 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a lightweight CI check to validate pull request titles against a bracketed component-prefix convention, aiming to improve PR consistency and adherence to extension repo contribution guidelines.

Changes:

  • Introduce a verify_pr_title Python module (extractors/rules/verifiers + CLI runner) to validate PR title format.
  • Define default rules requiring a leading [Component] or {Component} prefix and a non-empty description (with optional keywords).
  • Add a GitHub Actions workflow to run the check on PR open/edit/synchronize events.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
scripts/ci/verify_pr_title/verifiers.py Adds verifier abstractions and regex/non-empty validation helpers.
scripts/ci/verify_pr_title/extractors.py Adds title extractors for full title, prefix, and post-prefix text.
scripts/ci/verify_pr_title/rule.py Defines the Rule dataclass tying extractor + verifier.
scripts/ci/verify_pr_title/rules.py Establishes the default PR title validation rules and error messages.
scripts/ci/verify_pr_title/runner.py Implements the rule-evaluation loop returning failures.
scripts/ci/verify_pr_title/__main__.py Provides a CLI entrypoint for running validation in CI.
scripts/ci/verify_pr_title/__init__.py Exposes module API surface via imports and __all__.
.github/workflows/VerifyPRTitle.yml Adds the GitHub Actions workflow that runs the validator on PR events.

name="Component prefix present",
extractor=FullTitleExtractor(),
verifier=RegexVerifier(
pattern=r"^(\[.+?\]|\{.+?\})",
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The component-prefix regex allows whitespace-only components (e.g. "[ ] Fix ...") because it uses ".+?". This contradicts the error message claiming the bracket must be non-empty. Tighten the pattern to require at least one non-whitespace character inside the brackets so whitespace-only prefixes are rejected.

Suggested change
pattern=r"^(\[.+?\]|\{.+?\})",
pattern=r"^(\[(?!\s*\])[^]]+\]|\{(?!\s*\})[^}]+\})",

Copilot uses AI. Check for mistakes.
Comment on lines +18 to +27
_PATTERN = re.compile(r"^(\[.+?\]|\{.+?\})")

def extract(self, title: str) -> str:
m = self._PATTERN.match(title)
return m.group(1) if m else ""


class AfterPrefixExtractor(Extractor):
_PATTERN = re.compile(r"^(?:\[.+?\]|\{.+?\})\s*(.*)", re.DOTALL)

Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The extractor patterns for the component prefix (both ComponentPrefixExtractor and AfterPrefixExtractor) also accept whitespace-only bracket content due to ".+?". If you tighten the validation regex to require a non-whitespace character inside the brackets, these patterns should be updated in sync to avoid inconsistencies between extraction and validation.

Copilot uses AI. Check for mistakes.
from .rules import RULES


def run(title: str, rules: list[Rule] = RULES) -> list[tuple[str, str]]:
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

run() uses a module-level list (RULES) as a default argument. Even if you don’t mutate it today, this makes the function susceptible to accidental external mutation and harder to reason about in tests. Prefer a None default and assign RULES inside the function.

Suggested change
def run(title: str, rules: list[Rule] = RULES) -> list[tuple[str, str]]:
def run(title: str, rules: list[Rule] | None = None) -> list[tuple[str, str]]:
if rules is None:
rules = RULES

Copilot uses AI. Check for mistakes.
Comment on lines +8 to +9
"[Component] (BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>\n"
"{Component} (BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>"
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The printed "Expected format" string implies a required space after the prefix, but the current extraction/validation logic allows titles like "[Core]Fix #123: ..." (no space). Either enforce the space in the rules or adjust _EXPECTED_FORMAT so the CLI output matches what is actually accepted.

Suggested change
"[Component] (BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>\n"
"{Component} (BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>"
"[Component](BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>\n"
"{Component}(BREAKING CHANGE: | Hotfix[:] | Fix #<N>[:])? <description>"

Copilot uses AI. Check for mistakes.
for line in error.splitlines():
print(f" {line}")
print()
print(f"Expected format:\n {_EXPECTED_FORMAT}")
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

When printing Expected format, only the first line is indented; the second line starts at column 0 because _EXPECTED_FORMAT contains a newline. Consider formatting the output by splitting into lines and indenting each line for consistent readability.

Suggested change
print(f"Expected format:\n {_EXPECTED_FORMAT}")
expected_format_indented = "\n".join(f" {line}" for line in _EXPECTED_FORMAT.splitlines())
print(f"Expected format:\n{expected_format_indented}")

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Auto-Assign Auto assign by bot CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants