75 lines
2.5 KiB
YAML
75 lines
2.5 KiB
YAML
# Warning, do not check out untrusted code with
|
|
# the pull_request_target event.
|
|
name: Label PRs with Conventional Commits
|
|
on:
|
|
pull_request_target:
|
|
types: [opened, edited, synchronize]
|
|
merge_group:
|
|
|
|
jobs:
|
|
validate-pr-title:
|
|
name: Validate PR Title
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Validate PR title follows Conventional Commits
|
|
id: validate
|
|
uses: Namchee/conventional-pr@v0.15.6
|
|
with:
|
|
access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
issue: false
|
|
|
|
validate-pr-description:
|
|
name: Validate PR Description
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: read
|
|
steps:
|
|
- name: Check PR Description
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const body = context.payload.pull_request.body || '';
|
|
const title = context.payload.pull_request.title || '';
|
|
const prNumber = context.payload.pull_request.number;
|
|
|
|
console.log(`Checking PR #${prNumber}: ${title}`);
|
|
|
|
// Skip validation for bot PRs
|
|
if (context.payload.pull_request.user.type === 'Bot') {
|
|
console.log('Skipping validation for bot PR');
|
|
return;
|
|
}
|
|
|
|
// Check minimum description length (at least 10 characters)
|
|
const minLength = 10;
|
|
if (body.trim().length < minLength) {
|
|
core.setFailed(`PR description is too short. Please provide a meaningful description (at least ${minLength} characters).`);
|
|
return;
|
|
}
|
|
|
|
// Check for empty or placeholder descriptions
|
|
const placeholderPatterns = [
|
|
/^[\s\n]*$/,
|
|
/^(n\/a|na|none|no description|todo|tbd|wip)$/i,
|
|
/^[\-\*\s]*$/
|
|
];
|
|
|
|
for (const pattern of placeholderPatterns) {
|
|
if (pattern.test(body.trim())) {
|
|
core.setFailed('PR description appears to be empty or a placeholder. Please provide a meaningful description.');
|
|
return;
|
|
}
|
|
}
|
|
|
|
console.log('PR description validation passed!');
|
|
|
|
label:
|
|
needs: [validate-pr-title]
|
|
name: Label PR
|
|
runs-on: ubuntu-latest
|
|
if: ${{ github.event.pull_request.user.type != 'Bot'}}
|
|
steps:
|
|
- uses: bcoe/conventional-release-labels@v1
|
|
with:
|
|
type_labels: '{"feat": "enhancement","fix": "bug","docs": "documentation","style": "style","refactor": "refactor","perf": "performance","test": "test","chore": "chore","build": "build"}'
|
|
|