Skip to content

Commit c60d046

Browse files
committed
aasdkljalksdjalkjwdlkajskldjasldkjaiwldjasldkjasdlkajsd
1 parent 9d2e904 commit c60d046

File tree

1 file changed

+133
-0
lines changed

1 file changed

+133
-0
lines changed

.github/workflows/lint.yml

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: Lint and Biome Check
2+
3+
# Run the workflow when code is pushed or when a pull request is created
4+
on:
5+
push:
6+
branches:
7+
- '**'
8+
pull_request:
9+
branches:
10+
- main
11+
12+
jobs:
13+
biome:
14+
name: Run Biome
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
# Checkout the repository so the workflow has access to the code
19+
- name: Checkout code
20+
uses: actions/checkout@v3
21+
22+
# Run the run-biome.sh script
23+
- name: Run run-biome.sh
24+
run: scripts/run-biome.sh
25+
26+
commit-lint:
27+
name: Run Lint Commit
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Check Commit Messages
31+
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
32+
with:
33+
script: |
34+
const excludedBotIds = [
35+
49699333, // dependabot[bot]
36+
];
37+
const rules = [
38+
{
39+
pattern: /^[^\r]*$/,
40+
error: "Commit message contains CRLF line breaks (only unix-style LF linebreaks are allowed)",
41+
},
42+
{
43+
pattern: /^.+(\r?\n(\r?\n.*)*)?$/,
44+
error: "Empty line between commit title and body is missing",
45+
},
46+
{
47+
pattern: /^.{0,72}(?:\r?\n(?:(.{0,72})|(.*?([a-z]+:\/\/)?(([a-zA-Z0-9_]|-)+\.)+[a-z]{2,}(:\d+)?([a-zA-Z_0-9@:%\+.~\?&/=]|-)+).*?))*$/,
48+
error: "Commit message lines are too long (maximum allowed is 72 characters, except for URLs)",
49+
},
50+
{
51+
pattern: /^((?!^Merge branch )[\s\S])*$/,
52+
error: "Commit is a git merge commit, use the rebase command instead",
53+
},
54+
{
55+
pattern: /^\S.*?\S: .+/,
56+
error: "Missing category in commit title (if this is a fix up of a previous commit, it should be squashed)",
57+
},
58+
{
59+
pattern: /^\S.*?: [A-Z0-9]/,
60+
error: "First word of commit after the subsystem is not capitalized",
61+
},
62+
{
63+
pattern: /^.+[^.\n](\r?\n.*)*$/,
64+
error: "Commit title ends in a period",
65+
},
66+
{
67+
pattern: /^((?!Signed-off-by: )[\s\S])*$/,
68+
error: "Commit body contains a Signed-off-by tag",
69+
},
70+
];
71+
72+
const { repository, pull_request } = context.payload;
73+
74+
// NOTE: This maxes out at 250 commits. If this becomes a problem, see:
75+
// https://octokit.github.io/rest.js/v18#pulls-list-commits
76+
const opts = github.rest.pulls.listCommits.endpoint.merge({
77+
owner: repository.owner.login,
78+
repo: repository.name,
79+
pull_number: pull_request.number,
80+
});
81+
const commits = await github.paginate(opts);
82+
83+
const errors = [];
84+
for (const { sha, commit: { message }, author } of commits) {
85+
if (author !== null && excludedBotIds.includes(author.id)) {
86+
continue;
87+
}
88+
const commitErrors = [];
89+
for (const { pattern, error } of rules) {
90+
if (!pattern.test(message)) {
91+
commitErrors.push(error);
92+
}
93+
}
94+
if (commitErrors.length > 0) {
95+
const title = message.split("\n")[0];
96+
errors.push([`${title} (${sha}):`, ...commitErrors].join("\n "));
97+
}
98+
}
99+
100+
if (errors.length > 0) {
101+
core.setFailed(`One or more of the commits in this PR do not match the code submission policy:\n\n${errors.join("\n")}`);
102+
}
103+
104+
- name: Create PR comment on bad commit message
105+
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
106+
if: ${{ failure() && !github.event.pull_request.draft }}
107+
with:
108+
script: |
109+
// If a comment already exists, skip
110+
const { data: comments } = await github.rest.issues.listComments({
111+
issue_number: context.issue.number,
112+
owner: context.repo.owner,
113+
repo: context.repo.repo,
114+
});
115+
116+
const existingComment = comments.find(comment => comment.user.login === 'github-actions[bot]' && comment.body.includes('Bad Commit'));
117+
118+
if (existingComment) {
119+
core.info('Preview comment already exists. Skipping...');
120+
return;
121+
}
122+
123+
124+
const body = `### <span aria-hidden="true">❌</span>
125+
Hello!\n\nOne or more of the commit messages in this PR do not match the nginx-hugo-theme [git guidelines](https://github.com/nginxinc/nginx-hugo-theme/blob/main/CONTRIBUTING.md#git-guidelines), 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.
126+
`;
127+
128+
await github.rest.issues.createComment({
129+
issue_number: context.issue.number,
130+
owner: context.repo.owner,
131+
repo: context.repo.repo,
132+
body: body,
133+
});

0 commit comments

Comments
 (0)