ci: validate PR titles as conventional commits

Open Beginner friendly
  • Is something wrong?
#48 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, typescript
Domain
ci-cd

Research direction

Read AGENTS.md, release-please-config.json, and CONTRIBUTING.md first to confirm pinning and changelog conventions. Add .github/workflows/pr-title.yml with the specified pull request events, least-privilege permissions, stable job name, and title validation; document the convention in CONTRIBUTING.md. Verify that feat: add rule passes and added a rule fails.

Written by the indexing model from the issue text.

Description

enhancement ready-for-agent

Goal

Fail a PR check when the PR title is not a valid Conventional Commit. release-please reads commits on main, and with squash merging the PR title becomes the commit message, so the title is what needs validating.

Tasks

  • Add .github/workflows/pr-title.yml running on pull_request_target or pull_request (opened, edited, synchronize, reopened) with amannn/action-semantic-pull-request or an equivalent.
  • Pin the action to its commit SHA with the full semver in a trailing comment, using the latest stable release (gh api repos/<owner>/<repo>/releases/latest), per AGENTS.md.
  • Use least-privilege permissions (pull-requests: read).
  • Restrict allowed types to the ones release-please and the repo use (feat, fix, docs, chore, refactor, perf, test, build, ci, style, revert). Check release-please-config.json for the types that appear in the changelog.
  • Document the PR title convention in CONTRIBUTING.md.

Acceptance criteria

  • A PR titled feat: add rule passes and added a rule fails.
  • The job name is stable so a ruleset can require it (see the follow-up issue on repo settings).
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 8m
Merged PRs (30d)
64

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nemchik/biome-plugin-suitescript

All issues in nemchik/biome-plugin-suitescript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.