litestar-org / litestar-org/project-template
ci: add PR title linting (Conventional Commits)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## Context
Adopt PR-title linting (from litestar-org/project-template#16) so PR titles follow [Conventional Commits](https://www.conventionalcommits.org/) — matching the repo's PR-title convention and enabling downstream label/changelog automation.
Source workflow uses `amannn/action-semantic-pull-request` on `pull_request_target` with `permissions: pull-requests: read`.
## Proposed tasks
- [ ] Add `.github/workflows/pr-title.yml` running `amannn/action-semantic-pull-request`
- [ ] SHA-pin the action + top-level `permissions: {}` + minimal `pull-requests: read` (to pass the zizmor gate from #22/#39)
- [ ] Confirm the allowed types match our Conventional Commits usage
## Notes
- Safe use of `pull_request_target`: this workflow only reads the PR title; it must **not** check out or run PR head code.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed .github/workflows/pr-title.yml and compare the referenced project-template workflow using amannn/action-semantic-pull-request. Confirm the repository's Conventional Commits types, then verify the workflow uses a SHA-pinned action and the stated minimal permissions without checking out or running PR code. Done means the workflow is present and passes the zizmor gate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, security
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100