Skip to content

Commit e3260f3

Browse files
authored
feat: Add YScope PR template and PR title check workflow. (#9)
1 parent eb8fd9e commit e3260f3

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!-- markdownlint-disable MD012 -->
2+
3+
<!--
4+
Set the PR title to a meaningful commit message that:
5+
6+
* is in imperative form.
7+
* follows the Conventional Commits specification (https://www.conventionalcommits.org).
8+
* See https://github.com/commitizen/conventional-commit-types/blob/master/index.json for possible
9+
types.
10+
11+
Example:
12+
13+
fix: Don't add implicit wildcards ('*') at the beginning and the end of a query (fixes #390).
14+
-->
15+
16+
# Description
17+
18+
<!-- Describe what this request will change/fix and provide any details necessary for reviewers. -->
19+
20+
21+
22+
# Checklist
23+
24+
<!-- Ensure each item below is satisfied and indicate so by inserting an `x` within each `[ ]`. -->
25+
26+
* [ ] The PR satisfies the [contribution guidelines][yscope-contrib-guidelines].
27+
* [ ] This is a breaking change and that has been indicated in the PR title, OR this isn't a
28+
breaking change.
29+
* [ ] Necessary docs have been updated, OR no docs need to be updated.
30+
31+
# Validation performed
32+
33+
<!-- Describe what tests and validation you performed on the change. -->
34+
35+
36+
37+
[yscope-contrib-guidelines]: https://docs.yscope.com/dev-guide/contrib-guides-overview.html
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: "pr-title-checks"
2+
3+
on:
4+
pull_request_target:
5+
# NOTE: Workflows triggered by this event give the workflow access to secrets and grant the
6+
# `GITHUB_TOKEN` read/write repository access by default. So we need to ensure:
7+
# - This workflow doesn't inadvertently check out, build, or execute untrusted code from the
8+
# pull request triggered by this event.
9+
# - Each job has `permissions` set to only those necessary.
10+
types: ["edited", "opened", "reopened"]
11+
branches: ["release-0.293-clp-connector"]
12+
13+
permissions: {}
14+
15+
concurrency:
16+
group: "${{github.workflow}}-${{github.ref}}"
17+
18+
# Cancel in-progress jobs for efficiency
19+
cancel-in-progress: true
20+
21+
jobs:
22+
conventional-commits:
23+
permissions:
24+
# For amannn/action-semantic-pull-request
25+
pull-requests: "read"
26+
runs-on: "ubuntu-latest"
27+
steps:
28+
- uses: "amannn/action-semantic-pull-request@v5"
29+
env:
30+
GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"

0 commit comments

Comments
 (0)