Skip to content

[AV-102370] Add PR title and description checker script#344

Merged
PaulomeeCb merged 12 commits into
mainfrom
AV-102370-PR-title-check
Jun 6, 2025
Merged

[AV-102370] Add PR title and description checker script#344
PaulomeeCb merged 12 commits into
mainfrom
AV-102370-PR-title-check

Conversation

@PaulomeeCb

@PaulomeeCb PaulomeeCb commented May 22, 2025

Copy link
Copy Markdown
Contributor

Jira

  • AV-102370

Description

This PR-

  1. Includes a ci/cd check to make sure the PR title is in the correct format.
  2. Includes a check to make sure the correct PR description is included.
  3. Removes the type of change - [ ] This change requires a documentation update, as it is not required for terraform changes.
  4. Adds a type of change - [ ] This change updates the ci/cd workflow.
  5. Updates label-pr.yml to include the label for ci/cd

Type of Change

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update
  • Documentation fix/enhancement

Manual Testing Approach

How was this change tested and do you have evidence? (REQUIRED: Select at least 1)

  • Manually tested
  • Unit tested
  • Acceptance tested
  • Unable to test / will not test (Please provide comments in section below)

Testing

Testing Adding an incorrect title would fail the check-

Screenshot 2025-05-22 at 2 01 39 PM

And a github actions bot message-
Screenshot 2025-05-22 at 2 24 14 PM

Default line in the description-
Screenshot 2025-05-22 at 3 13 36 PM

Required Checklist:

  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if required)
  • I have run make fmt and formatted my code
  • I have made sure that no schema field is marked with both requiresReplace and computed

Further comments

@PaulomeeCb PaulomeeCb requested a review from a team as a code owner May 22, 2025 20:54
@github-actions github-actions Bot added the enhancement New feature or request label May 22, 2025
Comment thread .github/workflows/pr-title-check.yml Fixed
@PaulomeeCb PaulomeeCb changed the title AV-102370 - PR title checker script adding AV-102370 - Add PR title checker script May 22, 2025
@PaulomeeCb PaulomeeCb changed the title AV-102370 - Add PR title checker script [AV-102370] Add PR title checker script May 22, 2025
@PaulomeeCb PaulomeeCb marked this pull request as draft May 22, 2025 21:05
@PaulomeeCb PaulomeeCb changed the title [AV-102370] Add PR title checker script [AV-102370] Add PR Title Checker Script May 22, 2025
@PaulomeeCb PaulomeeCb changed the title [AV-102370] Add PR Title Checker Script [AV-102370] - PR Title Checker Script add May 22, 2025
@github-actions

Copy link
Copy Markdown

🚨 PR title "[AV-102370] - PR Title Checker Script add" does not match the required format.

Requirements:
- Must start with [AV-XXXXX] where X is any number of digits
- After the bracket, must start with a Verb (Add, Update, Fix, etc.)
- The Verb must start with an uppercase letter

Expected format: [AV-XXXXX] Verb ...
Example: [AV-98659] Implement Cluster On/Off feature
Valid verbs: Add, Update, Fix, Implement, Remove, Refactor, etc.

@PaulomeeCb PaulomeeCb changed the title [AV-102370] - PR Title Checker Script add [AV-102370] Add PR Title Checker Script May 22, 2025
@github-actions

Copy link
Copy Markdown

🚨 PR title "[AV-102370] - PR Title Checker Script add" does not match the required format.

Requirements:
- Must start with [AV-XXXXX] where X is any number of digits
- After the bracket, must start with a Verb (Add, Update, Fix, etc.)
- The Verb must start with an uppercase letter

Expected format: [AV-XXXXX] Verb ...
Example: [AV-98659] Implement Cluster On/Off feature
Valid verbs: Add, Update, Fix, Implement, Remove, Refactor, etc.

@PaulomeeCb PaulomeeCb changed the title [AV-102370] Add PR Title Checker Script [AV-102370] Add PR title checker script May 22, 2025
@github-actions

Copy link
Copy Markdown

🚨 PR title "[AV-102370] - PR Title Checker Script add" does not match the required format.

Requirements:
- Must start with [AV-XXXXX] where X is any number of digits
- After the bracket, must start with a Verb (Add, Update, Fix, etc.)
- The Verb must start with an uppercase letter

Expected format: [AV-XXXXX] Verb ...
Example: [AV-98659] Implement Cluster On/Off feature
Valid verbs: Add, Update, Fix, Implement, Remove, Refactor, etc.

@PaulomeeCb PaulomeeCb changed the title [AV-102370] Add PR title checker script [AV-102370] - add PR title checker script May 22, 2025
@github-actions

Copy link
Copy Markdown

🚨 PR title "[AV-102370] - add PR title checker script" does not match the required format.

Requirements:
- Must start with [AV-XXXXX] where X is any number of digits
- After the bracket, must start with a Verb (Add, Update, Fix, etc.)
- The Verb must start with an uppercase letter

Expected format: [AV-XXXXX] Verb ...
Example: [AV-98659] Implement Cluster On/Off feature
Valid verbs: Add, Update, Fix, Implement, Remove, Refactor, etc.

@PaulomeeCb PaulomeeCb changed the title [AV-102370] - add PR title checker script [AV-102370] Add PR title checker script May 22, 2025
@PaulomeeCb PaulomeeCb marked this pull request as ready for review May 22, 2025 21:41
@github-actions

Copy link
Copy Markdown

PR Description Error:
Your PR description needs attention.

Description Requirements:
- Must not contain the default template text
- Should include:
  * A clear summary of the changes
  * Motivation for the changes
  * Any relevant context

Please replace the default text with a meaningful description of your changes.

@PaulomeeCb PaulomeeCb changed the title [AV-102370] Add PR title checker script [AV-102370] Add PR title and description checker script May 22, 2025
@PaulomeeCb PaulomeeCb added ci/cd and removed enhancement New feature or request labels May 22, 2025
@couchbasecloud couchbasecloud deleted a comment from github-actions Bot Jun 6, 2025
@PaulomeeCb PaulomeeCb merged commit 68e0cf8 into main Jun 6, 2025
10 checks passed
@PaulomeeCb PaulomeeCb deleted the AV-102370-PR-title-check branch June 6, 2025 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants