23bac0fc76
This commit integrates `pylint` into the CI/CD pipeline to improve the quality of Python scripts within the project. By enforcing stricter linting standards, the aim is to identify and correct potential issues more efficiently, ultimately contributing to more reliable and maintainable code. Changes: - Introduce `npm run lint:pylint` command to facilitate unified way to run linting on different environments. - Include `npm run lint:pylint` in the CI/CD workflow to ensure all commits adhere to established Python coding standards. - Fix an issue identified by `pylint` in `configure_vscode.py`. - Rename the workflow to match the latest naming convention.
77 lines
2.0 KiB
YAML
77 lines
2.0 KiB
YAML
name: checks.quality
|
|
|
|
on: [ push, pull_request ]
|
|
|
|
jobs:
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
lint-command:
|
|
- npm run lint:eslint
|
|
- npm run lint:yaml
|
|
- npm run lint:md
|
|
- npm run lint:md:relative-urls
|
|
- npm run lint:md:consistency
|
|
os: [ macos, ubuntu, windows ]
|
|
fail-fast: false # Still interested to see results from other combinations
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@v4
|
|
-
|
|
name: Setup node
|
|
uses: ./.github/actions/setup-node
|
|
-
|
|
name: Install dependencies
|
|
uses: ./.github/actions/npm-install-dependencies
|
|
-
|
|
name: Lint
|
|
run: ${{ matrix.lint-command }}
|
|
|
|
todo-check:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@v4
|
|
-
|
|
name: Scan latest commit for TODO comments
|
|
shell: bash
|
|
run: |-
|
|
readonly todo_comment_search_pattern='TODO'':' # Define search pattern in parts to prevent IDE from flagging this script line as a TODO item
|
|
if git grep "$todo_comment_search_pattern" HEAD; then
|
|
echo 'TODO comments found in the latest commit.'
|
|
exit 1
|
|
else
|
|
echo 'No TODO comments found in the latest commit.'
|
|
exit 0
|
|
fi
|
|
|
|
pylint:
|
|
runs-on: ${{ matrix.os }}-latest
|
|
strategy:
|
|
matrix:
|
|
os: [ macos, ubuntu, windows ]
|
|
fail-fast: false # Still interested to see results from other combinations
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@v4
|
|
-
|
|
name: Setup node
|
|
uses: ./.github/actions/setup-node
|
|
-
|
|
name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.x'
|
|
-
|
|
name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install pylint
|
|
-
|
|
name: Analyzing the code with pylint
|
|
run: npm run lint:pylint
|