Skip to content

Commit ff4b79c

Browse files
committed
chore: Update title guidance in pull requests template (DBTP-1862)
1 parent 86f5bb8 commit ff4b79c

File tree

3 files changed

+38
-28
lines changed

3 files changed

+38
-28
lines changed

.github/pull_request_template.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Addresses https://uktrade.atlassian.net/browse/DBTP-<ticket>.
2+
3+
---
4+
## Checklist:
5+
6+
### Title:
7+
- [ ] Conforms to [our pull request title guidance](https://uktrade.atlassian.net/wiki/spaces/DBTP/pages/4402020487/Git+housekeeping#Pull-request-titles). E.g. `feat: Add new feature (DBTP-1234)` or `chore: Correct typo (off-ticket)`
8+
9+
### Description:
10+
- [ ] Link to ticket included (unless it's a quick out of ticket thing)
11+
- [ ] Includes tests (or an explanation for why it doesn't)
12+
- [ ] Includes any applicable changes to the documentation in this code base
+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Lint PR"
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
permissions:
11+
pull-requests: read
12+
13+
jobs:
14+
main:
15+
name: Validate PR title
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: amannn/action-semantic-pull-request@v5
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21+
with:
22+
# Check the subject matches guidance from https://uktrade.atlassian.net/wiki/spaces/DBTP/pages/4402020487/Git+housekeeping?force_transition=f6ce49ea-c406-402b-ac37-ed6145b46259#Pull-request-titles
23+
subjectPattern: ^[A-Z].* \([a-zA-Z]{1,}-[a-zA-Z0-9]{1,}\)+$
24+
subjectPatternError: |
25+
The subject "{subject}" found in the pull request title "{title}"
26+
didn't match the expected pattern. E.g. "feat: Add new feature (DBTP-1234)".

setup.py

-28
This file was deleted.

0 commit comments

Comments
 (0)