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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
name: Tests and Checks
# Only run CI on pushes to main and pull requests
# We don't run CI on other branches, but those should be merged into main via a PR anyways which will trigger CI before the merge.
on:
push:
branches:
- main
pull_request:
branches:
- main
concurrency:
group: ci-${{ github.ref }}-1
cancel-in-progress: true
jobs:
tests:
runs-on: "ubuntu-latest"
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", pypy-3.9]
os: ["macos-latest", "ubuntu-latest", "windows-latest"]
steps:
- uses: actions/checkout@v3.3.0
with:
ref: ${{ github.event.pull_request.head.sha }} # Checkout pull request HEAD commit instead of merge commit
fetch-depth: 0 # checkout all history, needed for hatch versioning
- name: Setup python
uses: actions/setup-python@v4.6.1
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
run: python -m pip install hatch==1.7.0
- name: Unit Tests
run: hatch run test:unit-tests
- name: Code formatting (black)
run: hatch run test:format
- name: Code linting (ruff)
run: hatch run test:lint
- name: Static type checking (mypy)
run: hatch run test:type-check
- name: Install local gitlint for integration tests
run: hatch run qa:install-local
- name: Integration tests
run: hatch run qa:integration-tests
if: matrix.os != 'windows-latest'
- name: Integration tests (GITLINT_QA_USE_SH_LIB=0)
run: hatch run qa:integration-tests -k "not(test_commit_hook_continue or test_commit_hook_abort or test_commit_hook_edit)" qa
env:
GITLINT_QA_USE_SH_LIB: 0
if: matrix.os != 'windows-latest'
- name: Integration tests (Windows)
run: |
hatch run qa:integration-tests -k "not (test_commit_hook_continue or test_commit_hook_abort or test_commit_hook_edit or test_lint_staged_stdin or test_stdin_file or test_stdin_pipe_empty)" qa
if: matrix.os == 'windows-latest'
# Run gitlint. Skip during PR runs, since PR commit messages are transient and usually full of gitlint violations.
# PRs get squashed and get a proper commit message during merge.
- name: gitlint --debug
run: hatch run dev:gitlint --debug
continue-on-error: ${{ github.event_name == 'pull_request' }} # Don't enforce gitlint in PRs
- name: Code Coverage (coveralls)
uses: coverallsapp/github-action@master
with:
path-to-lcov: ".coverage.lcov"
github-token: ${{ secrets.GITHUB_TOKEN }}
git-commit: ${{ github.event.pull_request.head.sha }}
flag-name: gitlint-${{ matrix.os }}-${{ matrix.python-version }}
parallel: true
build-test:
runs-on: "ubuntu-latest"
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", pypy-3.9]
os: ["macos-latest", "ubuntu-latest", "windows-latest"]
steps:
- uses: actions/checkout@v3.3.0
with:
ref: ${{ github.event.pull_request.head.sha }} # Checkout pull request HEAD commit instead of merge commit
fetch-depth: 0 # checkout all history, needed for hatch versioning
- name: Install pypa/build
run: python -m pip install build==0.10.0
- name: Build test (gitlint)
run: python -m build
- name: Upload sdist tarball (gitlint)
uses: actions/upload-artifact@v3
with:
name: sdist-gitlint-${{ matrix.python-version }}
path: dist/*.tar.gz
if: matrix.os == 'ubuntu-latest'
- name: Build test (gitlint-core)
run: python -m build
working-directory: ./gitlint-core
- name: Upload sdist tarball (gitlint-core)
uses: actions/upload-artifact@v3
with:
name: sdist-gitlint-core-${{ matrix.python-version }}
path: ./gitlint-core/dist/*.tar.gz
if: matrix.os == 'ubuntu-latest'
sdist-build-smoke-test:
# Ensure we can re-build gitlint from its sdist tarball (and that gitlint works after that)
# This is important for downstream packages (e.g. debian, homebrew, etc)
needs: build-test
runs-on: "ubuntu-latest"
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", pypy-3.9]
steps:
- name: Setup python ${{ matrix.python-version }}
uses: actions/setup-python@v4.6.1
with:
python-version: ${{ matrix.python-version }}
- name: Download sdist artifact (gitlint)
uses: actions/download-artifact@v3
with:
name: sdist-gitlint-${{ matrix.python-version }}
path: gitlint
- name: Download sdist artifact (gitlint-core)
uses: actions/download-artifact@v3
with:
name: sdist-gitlint-core-${{ matrix.python-version }}
path: gitlint-core
- name: Extract sdist tarball (gitlint)
run: tar xzvf *.tar.gz --strip-components=1
working-directory: ./gitlint
- name: Extract sdist tarball (gitlint-core)
run: tar xzvf *.tar.gz --strip-components=1
working-directory: ./gitlint-core
- name: Install pypa/build
run: python -m pip install build==0.10.0
- name: Build test (gitlint)
run: python -m build
working-directory: ./gitlint
- name: Build test (gitlint-core)
run: python -m build
working-directory: ./gitlint-core
- name: Install from wheel (gitlint and gitlint-core)
run: python -m pip install gitlint-core/dist/*.whl gitlint/dist/*.whl
# Make sure gitlint works
- name: gitlint --version
run: gitlint --version
doc-checks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.3.0
with:
ref: ${{ github.event.pull_request.head.sha }} # Checkout pull request HEAD commit instead of merge commit
- name: Setup python
uses: actions/setup-python@v4.6.1
with:
python-version: 3.11
- name: Install Hatch
run: python -m pip install hatch==1.7.0
- name: Docs validation (mkdocs build & linkchecker)
run: hatch run docs:validate
upload-coveralls:
needs: tests
runs-on: ubuntu-latest
steps:
- name: Upload coverage to coveralls
uses: coverallsapp/github-action@master
with:
path-to-lcov: ".coverage.lcov"
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel-finished: true
check: # This job does nothing and is only used for the branch protection
if: always() # Ref: https://github.com/marketplace/actions/alls-green#why
needs:
- tests
- build-test
- sdist-build-smoke-test
- doc-checks
- upload-coveralls
runs-on: ubuntu-latest
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}
# When on main, auto publish dev build
auto-publish-dev:
needs:
- check
if: github.ref == 'refs/heads/main'
uses: ./.github/workflows/publish-release.yml
secrets: inherit # pass all secrets (required to access secrets in a called workflow)
with:
environment: "production"
repo_release_ref: "main"
docker_image_tag: "latest_dev"
# When on main, auto publish docs
auto-publish-docs:
needs:
- check
if: github.ref == 'refs/heads/main'
uses: ./.github/workflows/publish-docs.yml
secrets: inherit # pass all secrets (required to access secrets in a called workflow)
with:
docs_version: "dev"
# After merging a PR, leave a comment on the PR with a link to the new dev build
notify:
needs:
- auto-publish-dev
if: github.ref == 'refs/heads/main'
runs-on: "ubuntu-latest"
steps:
# Checkout code in order to determine PR number
- uses: actions/checkout@v3.3.0
with:
fetch-depth: 0
- name: Get PR number
run: |
commit_sha=$(git rev-parse HEAD)
pr_number=$(curl -s -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
"https://api.github.com/repos/jorisroovers/gitlint/commits/$commit_sha/pulls" | jq -r '.[0].number')
echo "PR_NUMBER=$pr_number" >> $GITHUB_ENV
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/github-script@v6
with:
script: |
const body = `Build \
[${{ needs.auto-publish-dev.outputs.gitlint_version }}](https://pypi.org/project/gitlint/${{ needs.auto-publish-dev.outputs.gitlint_version }}) \
is now available on PyPI!
Install using:
\`\`\`sh
pip install gitlint==${{ needs.auto-publish-dev.outputs.gitlint_version }}
\`\`\`
`;
github.rest.issues.createComment({
issue_number: process.env.PR_NUMBER,
owner: context.repo.owner,
repo: context.repo.repo,
body: body
});
|
