forked from aseprite/laf
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# Based on SerenityOS commit linter: | ||
# https://github.com/SerenityOS/serenity/blob/master/.github/workflows/lintcommits.yml | ||
|
||
name: Commit linter | ||
on: [pull_request_target] | ||
jobs: | ||
lint_commits: | ||
runs-on: ubuntu-22.04 | ||
if: always() && github.repository == 'aseprite/laf' | ||
steps: | ||
- name: Lint PR commits | ||
uses: actions/github-script@v7 | ||
with: | ||
script: | | ||
const rules = [ | ||
{ | ||
pattern: /^[^\r]*$/, | ||
error: "Commit message contains CRLF line breaks (only unix-style LF linebreaks are allowed)", | ||
}, | ||
{ | ||
pattern: /^.+(\r?\n(\r?\n.*)*)?$/, | ||
error: "Empty line between commit title and body is missing", | ||
}, | ||
{ | ||
pattern: /^.{0,72}(?:\r?\n(?:(.{0,72})|(.*?([a-z]+:\/\/)?(([a-zA-Z0-9_]|-)+\.)+[a-z]{2,}(:\d+)?([a-zA-Z_0-9@:%\+.~\?&/=]|-)+).*?))*$/, | ||
error: "Commit message lines are too long (maximum allowed is 72 characters, except for URLs)", | ||
}, | ||
{ | ||
pattern: /^.+[^.\n](\r?\n.*)*$/, | ||
error: "Commit title ends in a period", | ||
}, | ||
{ | ||
pattern: /^((?!Signed-off-by: )[\s\S])*$/, | ||
error: "Commit body contains a Signed-off-by tag", | ||
}, | ||
]; | ||
const { repository, pull_request } = context.payload; | ||
// NOTE: This maxes out at 250 commits. If this becomes a problem, see: | ||
// https://octokit.github.io/rest.js/v18#pulls-list-commits | ||
const opts = github.rest.pulls.listCommits.endpoint.merge({ | ||
owner: repository.owner.login, | ||
repo: repository.name, | ||
pull_number: pull_request.number, | ||
}); | ||
const commits = await github.paginate(opts); | ||
const errors = []; | ||
for (const { sha, commit: { message }, author } of commits) { | ||
if (author !== null) { | ||
continue; | ||
} | ||
const commitErrors = []; | ||
for (const { pattern, error } of rules) { | ||
if (!pattern.test(message)) { | ||
commitErrors.push(error); | ||
} | ||
} | ||
if (commitErrors.length > 0) { | ||
const title = message.split("\n")[0]; | ||
errors.push([`${title} (${sha}):`, ...commitErrors].join("\n ")); | ||
} | ||
} | ||
if (errors.length > 0) { | ||
core.setFailed(`One or more of the commits in this PR do not match the code submission policy:\n\n${errors.join("\n")}`); | ||
} | ||
- name: Comment on PR | ||
if: ${{ failure() && !github.event.pull_request.draft }} | ||
uses: unsplash/comment-on-pr@a9bf050e744c8282dee4bb0dbcf063186d8316c4 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.LINT_COMMIT_TOKEN }} | ||
with: | ||
msg: "Hi there!\n\nOne or more of the commit messages in this PR do not match our [code submission policy](https://github.com/aseprite/laf/blob/main/CONTRIBUTING.md), please check the `lint_commits` CI job for more details on which commits were flagged and why.\nPlease do not close this PR and open another, instead modify your commit message(s) with [git commit --amend](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message) and force push those changes to update this PR." |