Skip to content

ci: fail PR if title does not match Conventional Commits format @W-21613569@ [post-tdx]#146

Merged
hsinghbisht-sfdc merged 2 commits intomainfrom
mohanraj-r/add-pr-title-check
Apr 8, 2026
Merged

ci: fail PR if title does not match Conventional Commits format @W-21613569@ [post-tdx]#146
hsinghbisht-sfdc merged 2 commits intomainfrom
mohanraj-r/add-pr-title-check

Conversation

@mohanraj-r
Copy link
Copy Markdown
Contributor

@mohanraj-r mohanraj-r commented Mar 31, 2026

References: Contributing guide · Skill authoring guide · Agent Skills spec

What changed

Added a new conventional-commit-title CI job to .github/workflows/validate-pr.yml that validates PR titles against the Conventional Commits format on every opened, reopened, and edited PR event targeting main.

  • TODO: change release workflow to post a comment about the released npm package version to the merged PR for visibility/tracking.

@W-21613569@

Why

Enforces a consistent, machine-readable commit history. Conventional Commit titles are required for automated changelog generation and semantic versioning tooling (e.g. standard-version, release-please). Without a hard gate, non-conforming titles slip through and break those pipelines.

Notes

  • Runs as a separate job in parallel with the existing pr-title (reusable workflow) job — no change to existing behaviour.
  • PR title is passed via env: (not inline ${{ }}) to prevent shell injection.
  • Accepted types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test.
  • Breaking-change marker (!) and optional scope are both supported.

Skills

Manual checklist

Description quality

  • Describes what the skill does and the expected output
  • Includes relevant Salesforce domain keywords (Apex, LWC, SOQL, metadata types, etc.)
  • Trigger phrases are specific enough for Vibes to select this skill reliably

Instructions

  • Clear goal statement
  • Step-by-step workflow
  • Validation rules for generated output
  • Defined output / artifact

Context efficiency

  • Core instructions are concise — supporting material lives in templates/, examples/, or docs/ subdirectories
  • No unnecessary background explanation in the body

Automated checks

Enforced by CI (npm run validate:skills) per the Agent Skills spec:

  • Directory is one level deep, named in kebab-case (max 64 chars), contains SKILL.md
  • Frontmatter name matches directory name; description is present, ≥ 20 words, ≤ 1024 characters, and includes trigger language
  • Body is non-empty and under 500 lines
  • Name uses gerund form ⚠ (warning — does not block merge)

@mohanraj-r mohanraj-r changed the title ci: fail PR if title does not match Conventional Commits format ci: fail PR if title does not match Conventional Commits format @W-21613569@ Mar 31, 2026
@mohanraj-r mohanraj-r changed the title ci: fail PR if title does not match Conventional Commits format @W-21613569@ foo: fail PR if title does not match Conventional Commits format @W-21613569@ Mar 31, 2026
@mohanraj-r mohanraj-r changed the title foo: fail PR if title does not match Conventional Commits format @W-21613569@ ci: fail PR if title does not match Conventional Commits format @W-21613569@ Mar 31, 2026
@vratan-sf vratan-sf changed the title ci: fail PR if title does not match Conventional Commits format @W-21613569@ ci: fail PR if title does not match Conventional Commits format @W-21613569@ [post-tdx] Apr 7, 2026
@hsinghbisht-sfdc hsinghbisht-sfdc merged commit eaf5acd into main Apr 8, 2026
2 checks passed
@hsinghbisht-sfdc hsinghbisht-sfdc deleted the mohanraj-r/add-pr-title-check branch April 8, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants