246 lines (200 loc) · 9.94 KB
/
commits.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
name: Commits
permissions:
contents: read
on: [workflow_dispatch, pull_request, push]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
check:
name: Commits - Check
runs-on: ubuntu-20.04
# We assume that commit 2fd0d36fe6ae0c2d527368683ec3a6352617b381 will be in the history
# of all commits based on ockam develop branch
# https://github.com/build-trust/ockam/commit/2fd0d36fe6ae0c2d527368683ec3a6352617b381
env:
FIRST_COMMIT: 2fd0d36fe6ae0c2d527368683ec3a6352617b381
steps:
- name: Checkout
if: github.event_name != 'pull_request'
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
with:
fetch-depth: 0 # checkout full tree
- name: Checkout (Pull Request)
if: github.event_name == 'pull_request'
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
with:
fetch-depth: 0 # checkout full tree
ref: ${{ github.event.pull_request.head.sha }}
- name: Get commit information from Github (Pull Request)
if: github.event_name == 'pull_request'
run: gh api repos/build-trust/ockam/pulls/${{ github.event.number }}/commits > commits.json
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Set FIRST_COMMIT To Begin Linting (Pull Request)
if: github.event_name == 'pull_request'
run: |
pull_request_commits_length=$(cat commits.json | jq '. | length')
echo "Number of commits in pull requests are $pull_request_commits_length"
echo "FIRST_COMMIT=HEAD~${pull_request_commits_length}" >> $GITHUB_ENV
- name: Check FIRST_COMMIT is ancestor of HEAD
run: |
git merge-base --is-ancestor $FIRST_COMMIT HEAD || \
(echo "
This workflow checks that all commits follow the Ockam Commit Message Convention
https://github.com/build-trust/.github/blob/main/CONTRIBUTING.md#commit-messages
We check all commits from HEAD backwards till the commit with commit hash: ${FIRST_COMMIT}.
ERROR:
For this to work the commit with commit hash: ${FIRST_COMMIT} should be an ancestor of HEAD
but it seems this is not the case with the current HEAD.
Try rebasing to the develop branch of ockam.
https://github.com/build-trust/ockam/tree/develop
" && exit 1)
- name: Check no merge commits
run: |
merge_commit_count=$(git rev-list --no-walk --count --merges $FIRST_COMMIT..HEAD)
if [ "$merge_commit_count" != "0" ]; then
echo "
Our develop branch follows a linear history and cannot have merge commits.
Please rebase to develop.
" && exit 1
fi
- name: Install Commitlint
run: npm install --location=global @commitlint/cli@16.3.0 # TODO: move to ockam-builder docker image.
- name: Lint Commit Messages
run: |
npx commitlint \
--config tools/commitlint/commitlint.config.js \
--from $FIRST_COMMIT \
--to HEAD \
--help-url https://github.com/build-trust/.github/blob/main/CONTRIBUTING.md#commit-messages || \
(echo '
The commit with the above commit message does not follow the Ockam Commit Message Convention
https://github.com/build-trust/.github/blob/main/CONTRIBUTING.md#commit-messages
Our commits should have the following structure.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Common errors to avoid:
1. The commit header <type>(<scope>): <subject> must be in lower case.
2. Allowed type values are: build, chore, ci, docs, feat, fix, refactor, style, test.
3. Allowed scope values are: c, elixir, typescript, rust.
4. Use the chore type as a last resort, prefer a more meaningful type.
5. Only feat, fix, refactor type commits are included in our changelog.
The linting rules are defined in:
https://github.com/build-trust/ockam/blob/develop/tools/commitlint/commitlint.config.js
More about the Ockam Commit Message Convention
https://github.com/build-trust/.github/blob/main/CONTRIBUTING.md#commit-messages
' && exit 1)
- name: Get Contributors List
run: |
curl --proto '=https' --tlsv1.2 --silent --show-error --fail \
https://raw.githubusercontent.com/build-trust/ockam-contributors/main/CONTRIBUTORS.csv \
> CONTRIBUTORS.csv
- name: Split Contributors List
shell: python
run: |
import csv
import re
import sys
contributors_github_usernames = []
contributors_emails = []
email_pattern = re.compile("<([^>]+)>")
with open('CONTRIBUTORS.csv', 'r') as f:
reader = csv.reader(f)
# skip the first row of headers
next(reader)
for line in reader:
contributors_github_usernames = contributors_github_usernames + line[1].split()
contributors_emails = contributors_emails + email_pattern.findall(line[3])
with open('CONTRIBUTORS_GITHUB_USERNAMES.txt', 'w') as f:
print('\n'.join(contributors_github_usernames), file=f)
with open('CONTRIBUTORS_EMAILS.txt', 'w') as f:
print('\n'.join(contributors_emails), file=f)
- name: Check Pull Request Sender has accepted Ockam CLA.
if: github.event_name == 'pull_request'
env:
PR_SENDER: ${{ github.event.pull_request.user.login }}
run: |
if grep -q -iF "$PR_SENDER" 'CONTRIBUTORS_GITHUB_USERNAMES.txt'; then
echo "[✓] Pull Request Sender $PR_SENDER has accepted the CLA."
else
echo "
$PR_SENDER, welcome to the Ockam community and thank you for sending this pull request ❤️.
Before we can merge, please accept our Contributor License Agreement (CLA).
1. Read the CLA at: https://github.com/build-trust/ockam-contributors/blob/main/CLA.md
2. To accept the CLA, please send a different pull request to our
[contributors repository](https://github.com/build-trust/ockam-contributors) indicating
that you accept the CLA by adding your Git/Github details in a row at the end of the
[CONTRIBUTORS.csv](https://github.com/build-trust/ockam-contributors/blob/main/CONTRIBUTORS.csv)
file.
We look forward to merging your first contribution!
"
exit 1
fi
- name: Check all commit authors and committers have accepted Ockam CLA.
run: |
commits=$(git rev-list --reverse $FIRST_COMMIT..HEAD)
commits=($FIRST_COMMIT ${commits[@]})
err=false
for commit in "${commits[@]}"
do
echo -e "\n---\nCommit: $commit"
author=$(git show -s --format='%ae' $commit)
echo "Author: $author"
committer=$(git show -s --format='%ce' $commit)
echo "Committer: $committer"
if grep -q -iF "$author" 'CONTRIBUTORS_EMAILS.txt'; then
echo "[✓] $commit author $author has accepted the CLA."
else
echo -e "$commit commit author $author has not accepted the CLA."
err=true
fi
if grep -q -iF "$committer" 'CONTRIBUTORS_EMAILS.txt'; then
echo "[✓] $commit committer $committer has accepted the CLA."
else
echo -r "\nERROR:\n$commit committer $committer has not accepted the CLA"
err=true
fi
if [ "$err" = true ]; then
echo "
Before we can merge, please accept our Contributor License Agreement (CLA).
1. Read the CLA at: https://github.com/build-trust/ockam-contributors/blob/main/CLA.md
2. To accept the CLA, please send a different pull request to our
[contributors repository](https://github.com/build-trust/ockam-contributors) indicating
that you accept the CLA by adding your Git/Github details in a row at the end of the
[CONTRIBUTORS.csv](https://github.com/build-trust/ockam-contributors/blob/main/CONTRIBUTORS.csv)
file.
We look forward to merging your contribution!
"
exit 1
fi
done
- name: Get Developers List
run: |
curl --proto '=https' --tlsv1.2 --silent --show-error --fail \
https://raw.githubusercontent.com/build-trust/ockam-contributors/main/DEVELOPERS.csv \
> DEVELOPERS.csv
- name: Check all commits in are Verified by Github (Pull Request)
if: github.event_name == 'pull_request'
env:
PR_SENDER: ${{ github.event.pull_request.user.login }}
run: |
unverified=$(cat commits.json | jq --raw-output '.[] | [.sha, .commit.verification.verified] | @csv' | grep false || echo '')
if [ -z "$unverified" ]; then
echo '[✓] All commits in this pull request are Verified by Github.'
elif grep -q -i ^"$PR_SENDER"$ 'DEVELOPERS.csv'; then
echo "::warning:: [!] Some commits are unverified, ignoring them since pull request sender is a developer."
echo "$unverified"
else
echo '
We require that all commits in a pull request are signed and Verified by Github
Please read about signing commits at:
https://docs.github.com/en/authentication/managing-commit-signature-verification
ERROR: The following commits are not Verified by Github.
'
echo "$unverified"
exit 1
fi