forked from python-discord/sir-lancebot
-
Notifications
You must be signed in to change notification settings - Fork 0
77 lines (67 loc) · 2.93 KB
/
lint.yaml
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
name: Lint
on: workflow_call
jobs:
lint:
name: Run linting & tests
runs-on: ubuntu-latest
env:
# List of licenses that are compatible with the MIT License and
# can be used in our project
ALLOWED_LICENSES: Apache Software License;
BSD; BSD License;
GNU Library or Lesser General Public License (LGPL);
Historical Permission Notice and Disclaimer (HPND);
ISC License (ISCL);
MIT License;
Mozilla Public License 2.0 (MPL 2.0);
Public Domain;
Python Software Foundation License
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Python Dependencies
uses: HassanAbouelela/actions/setup-python@setup-python_v1.6.0
with:
python_version: "3.12"
# Check all of our dev dependencies are compatible with the MIT license.
# If you added a new dependencies that is being rejected,
# please make sure it is compatible with the license for this project,
# and add it to the ALLOWED_LICENSE variable
- name: Check Dependencies License
run: |
poetry self add poetry-plugin-export
pip-licenses --allow-only="$ALLOWED_LICENSE" \
--package $(poetry export -f requirements.txt --without-hashes | sed "s/==.*//g" | tr "\n" " ")
# Attempt to run the bot. Setting `IN_CI` to true, so bot.run() is never called.
# This is to catch import and cog setup errors that may appear in PRs, to avoid crash loops if merged.
- name: Attempt bot setup
run: "python -m bot"
env:
REDIS_USE_FAKEREDIS: true
CLIENT_IN_CI: true
CLIENT_TOKEN: ""
- name: Run pre-commit hooks
run: SKIP=ruff pre-commit run --all-files
# Run `ruff` using github formatting to enable automatic inline annotations.
- name: Run ruff
run: "ruff check --output-format=github ."
# Prepare the Pull Request Payload artifact. If this fails, we
# we fail silently using the `continue-on-error` option. It's
# nice if this succeeds, but if it fails for any reason, it
# does not mean that our lint checks failed.
- name: Prepare Pull Request Payload artifact
id: prepare-artifact
if: always() && github.event_name == 'pull_request'
continue-on-error: true
run: cat $GITHUB_EVENT_PATH | jq '.pull_request' > pull_request_payload.json
# This only makes sense if the previous step succeeded. To
# get the original outcome of the previous step before the
# `continue-on-error` conclusion is applied, we use the
# `.outcome` value. This step also fails silently.
- name: Upload a Build Artifact
if: always() && steps.prepare-artifact.outcome == 'success'
continue-on-error: true
uses: actions/upload-artifact@v4
with:
name: pull-request-payload
path: pull_request_payload.json