From 59679006679944c672ab2ca17187117510be5925 Mon Sep 17 00:00:00 2001 From: Victor Santos Date: Fri, 28 Nov 2025 17:16:53 -0300 Subject: [PATCH] chore: standardize PR title format and ensure description starts with lowercase --- .github/pull_request_template.md | 2 +- .github/workflows/validate-pr-title.yml | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bec62f0bcb..2803cbbb55 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -19,7 +19,7 @@ ## Checklist -- [ ] Title follows format: `type(scope): Short description` (scope is optional, e.g., `fix: Prevent crash on sync` or `fix(api): Handle null response`) +- [ ] Title follows the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: `type(scope): short description` (scope is optional, e.g., `fix: prevent crash on sync` or `fix(api): handle null response`). - [ ] Tested locally - [ ] Updated docs (if needed) - [ ] Read the [contributing guide](https://infisical.com/docs/contributing/getting-started/overview) \ No newline at end of file diff --git a/.github/workflows/validate-pr-title.yml b/.github/workflows/validate-pr-title.yml index 650690329c..1e590139c4 100644 --- a/.github/workflows/validate-pr-title.yml +++ b/.github/workflows/validate-pr-title.yml @@ -18,11 +18,11 @@ jobs: // Valid PR types based on pull_request_template.md const validTypes = ['fix', 'feature', 'improvement', 'breaking', 'docs', 'chore']; - // Regex pattern: type(optional-scope): Short description + // Regex pattern: type(optional-scope): short description // - Type must be one of the valid types // - Scope is optional, must be in parentheses, lowercase alphanumeric with hyphens - // - Followed by colon, space, and description - const pattern = new RegExp(`^(${validTypes.join('|')})(\\([a-z0-9-]+\\))?: .+$`); + // - Followed by colon, space, and description (must start with lowercase letter) + const pattern = new RegExp(`^(${validTypes.join('|')})(\\([a-z0-9-]+\\))?: [a-z].+$`); if (!pattern.test(title)) { const errorMessage = ` @@ -30,7 +30,7 @@ jobs: Your PR title: \`${title}\` - **Expected format:** \`type(scope): Short description\` + **Expected format:** \`type(scope): short description\` (description must start with lowercase) **Valid types:** - \`fix\` - Bug fixes @@ -43,9 +43,9 @@ jobs: **Scope:** Optional, short identifier in parentheses (e.g., \`(api)\`, \`(auth)\`, \`(ui)\`) **Examples:** - - \`fix: Prevent crash on sync\` - - \`fix(api): Handle null response from auth endpoint\` - - \`docs(cli): Update installation guide\` + - \`fix: prevent crash on sync\` + - \`fix(api): handle null response from auth endpoint\` + - \`docs(cli): update installation guide\` `; core.setFailed(errorMessage);