File tree 2 files changed +45
-0
lines changed
2 files changed +45
-0
lines changed Original file line number Diff line number Diff line change
1
+ name : AUTHORS file
2
+
3
+ on :
4
+ pull_request : { }
5
+
6
+ jobs :
7
+ authors-file :
8
+ name : AUTHORS file
9
+ runs-on : ubuntu-latest
10
+
11
+ steps :
12
+ - name : Checkout HEAD
13
+ uses : actions/checkout@v3
14
+ with :
15
+ fetch-depth : 0
16
+
17
+ - name : Check whether ./AUTHORS is up-to-date
18
+ run : |
19
+ set -exo pipefail
20
+ sort -uo AUTHORS AUTHORS
21
+ git add AUTHORS
22
+ git log --format='format:%aN <%aE>' "$(
23
+ git merge-base "origin/$GITHUB_BASE_REF" "origin/$GITHUB_HEAD_REF"
24
+ )..origin/$GITHUB_HEAD_REF" >> AUTHORS
25
+ sort -uo AUTHORS AUTHORS
26
+ git diff AUTHORS >> AUTHORS.diff
27
+
28
+ - name: Complain if ./AUTHORS isn't up-to-date
29
+ run: |
30
+ if [ -s AUTHORS.diff ]; then
31
+ cat <<'EOF' >&2
32
+ There are the following new authors. If the commit author data is correct,
33
+ either add them to the AUTHORS file or update .mailmap. See gitmailmap(5) or:
34
+ https://git-scm.com/docs/gitmailmap
35
+ Don't hesitate to ask us for help if necessary.
36
+ EOF
37
+ cat AUTHORS.diff
38
+ exit 1
39
+ fi
Original file line number Diff line number Diff line change @@ -111,6 +111,12 @@ refs #1234
111
111
You can add multiple commits during your journey to finish your patch.
112
112
Don't worry, you can squash those changes into a single commit later on.
113
113
114
+ Ensure your name and email address in the commit metadata are correct.
115
+ In your first contribution (PR) also add them to [ AUTHORS] ( ./AUTHORS ) .
116
+ If those metadata changed since your last successful contribution,
117
+ you should update [ AUTHORS] ( ./AUTHORS ) and [ .mailmap] ( ./.mailmap ) .
118
+ For the latter see [ gitmailmap(5)] ( https://git-scm.com/docs/gitmailmap ) .
119
+
114
120
## <a id =" contributing-pull-requests " ></a > Pull Requests
115
121
116
122
Once you've commited your changes, please update your local master
You can’t perform that action at this time.
0 commit comments