mirror of
https://github.com/theupriser/steamify-cachyos.git
synced 2026-10-03 17:41:58 +02:00
ci: Lint workflow (shellcheck, ruff, qmllint) and make lint
This commit is contained in:
1 parent
272e073784
commit
99f7fea4d1
4 files changed
+78
-2
No files matched your search
@@ -0,0 +1,60 @@
|
|||||||
|
# Lint: shell, Python and QML. Separate from bundle.yml (which builds and
|
||||||
|
# releases) so a style problem shows up as its own check. Runs on GitHub and on
|
||||||
|
# the Gitea mirror; the same checks locally: make check.
|
||||||
|
name: Lint
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main, 'release/**']
|
||||||
|
pull_request:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
shell:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
# The sources, not only the bundle (bundle.yml checks that): .shellcheckrc
|
||||||
|
# lists the exceptions (variables shared across modules).
|
||||||
|
- name: shellcheck the modules
|
||||||
|
uses: ludeeus/action-shellcheck@2.0.0
|
||||||
|
with:
|
||||||
|
severity: warning
|
||||||
|
scandir: lib
|
||||||
|
additional_files: steamify.sh ui/steamify-app.sh .github/tools/bundle.sh
|
||||||
|
# steamify-os-release.sh is a template (@STEAMOS@ is filled in at install time).
|
||||||
|
- name: shellcheck the helper scripts
|
||||||
|
uses: ludeeus/action-shellcheck@2.0.0
|
||||||
|
with:
|
||||||
|
severity: warning
|
||||||
|
scandir: patches
|
||||||
|
ignore_names: steamify-os-release.sh
|
||||||
|
|
||||||
|
python:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: ruff (ruff.toml)
|
||||||
|
uses: astral-sh/ruff-action@v4.1.0
|
||||||
|
with:
|
||||||
|
args: check ui/steamify-ui patches
|
||||||
|
|
||||||
|
qml:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
# Not blocking until it has run once on the runner image (Qt packages).
|
||||||
|
continue-on-error: true
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install qmllint and the QML modules the app imports
|
||||||
|
run: |
|
||||||
|
sudo apt-get update -qq
|
||||||
|
sudo apt-get install -y -qq qt6-declarative-dev-tools qml6-module-qtquick qml6-module-qtquick-controls qml6-module-qtquick-window
|
||||||
|
# "unqualified" (a screen reading `app` from its parent) is how the screens get their
|
||||||
|
# AppState, so it is off; everything else must be clean.
|
||||||
|
- name: qmllint
|
||||||
|
run: |
|
||||||
|
lint="$(command -v qmllint6 || echo /usr/lib/qt6/bin/qmllint)"
|
||||||
|
"$lint" --unqualified disable --max-warnings 0 ui/qml/*.qml
|
||||||
@@ -12,6 +12,7 @@ one per merged pull request.
|
|||||||
- **refactor: the entry point picks its mode once (`MODE`) and `--defaults` and `--boot` are functions with one failure report, instead of four booleans and two copies of the apply-and-report code; `NO_COLOR` gives plain output**
|
- **refactor: the entry point picks its mode once (`MODE`) and `--defaults` and `--boot` are functions with one failure report, instead of four booleans and two copies of the apply-and-report code; `NO_COLOR` gives plain output**
|
||||||
- **refactor: `is_wanted` and `is_current` instead of repeated `[[ "${WANTED[x]}" == 1 ]]` checks in the menu, the app's backend and the entry point**
|
- **refactor: `is_wanted` and `is_current` instead of repeated `[[ "${WANTED[x]}" == 1 ]]` checks in the menu, the app's backend and the entry point**
|
||||||
- **refactor: the start of every item's JSON (id, label, hint, kind, parent) is built in one place (`json_item_head`) for the app and the installer page, and `json_bool` replaces the `&& echo true || echo false` copies**
|
- **refactor: the start of every item's JSON (id, label, hint, kind, parent) is built in one place (`json_item_head`) for the app and the installer page, and `json_bool` replaces the `&& echo true || echo false` copies**
|
||||||
|
- **ci: a Lint workflow runs shellcheck on the modules and helper scripts, ruff on the app and `patches/*.py` (`ruff.toml`) and qmllint on the QML (not blocking until it has run once on the runner); `make lint` runs the same locally**
|
||||||
- **test: the menu rules, the plan and the app's and installer's JSON are checked against a golden file (`tests/menu-test.sh` in steamify-cachyos-dev); `make check`, `.editorconfig`, `.shellcheckrc`**
|
- **test: the menu rules, the plan and the app's and installer's JSON are checked against a golden file (`tests/menu-test.sh` in steamify-cachyos-dev); `make check`, `.editorconfig`, `.shellcheckrc`**
|
||||||
- **docs: README lists the sources and projects Steamify builds on, with licences and thanks**
|
- **docs: README lists the sources and projects Steamify builds on, with licences and thanks**
|
||||||
|
|
||||||
|
|||||||
@@ -4,16 +4,25 @@ SH := steamify.sh $(wildcard lib/*.sh) ui/steamify-app.sh .github/tools/bundle.s
|
|||||||
DEV ?= ../steamify-cachyos-dev
|
DEV ?= ../steamify-cachyos-dev
|
||||||
TESTS := $(wildcard $(DEV)/tests/*-test.sh)
|
TESTS := $(wildcard $(DEV)/tests/*-test.sh)
|
||||||
|
|
||||||
.PHONY: check syntax lint test bundle fmt-check
|
.PHONY: check syntax lint lint-sh lint-py lint-qml test bundle fmt-check
|
||||||
check: syntax lint test bundle
|
check: syntax lint test bundle
|
||||||
|
|
||||||
syntax:
|
syntax:
|
||||||
@for f in $(SH); do bash -n "$$f" || exit 1; done
|
@for f in $(SH); do bash -n "$$f" || exit 1; done
|
||||||
python3 -c 'import ast, sys; [ast.parse(open(f).read(), f) for f in sys.argv[1:]]' ui/steamify-ui patches/*.py
|
python3 -c 'import ast, sys; [ast.parse(open(f).read(), f) for f in sys.argv[1:]]' ui/steamify-ui patches/*.py
|
||||||
|
|
||||||
lint:
|
lint: lint-sh lint-py lint-qml
|
||||||
|
|
||||||
|
lint-sh:
|
||||||
@command -v shellcheck >/dev/null && shellcheck -S warning $(SH) || echo "shellcheck not installed: skipped"
|
@command -v shellcheck >/dev/null && shellcheck -S warning $(SH) || echo "shellcheck not installed: skipped"
|
||||||
|
|
||||||
|
lint-py:
|
||||||
|
@command -v ruff >/dev/null && ruff check ui/steamify-ui patches || echo "ruff not installed: skipped"
|
||||||
|
|
||||||
|
lint-qml:
|
||||||
|
@Q="$$(command -v qmllint6 || command -v qmllint || ls /usr/lib/qt6/bin/qmllint 2>/dev/null)"; \
|
||||||
|
[ -n "$$Q" ] && "$$Q" --unqualified disable --max-warnings 0 ui/qml/*.qml || echo "qmllint not installed: skipped"
|
||||||
|
|
||||||
test:
|
test:
|
||||||
@for t in $(TESTS); do echo "== $$t"; REPO="$(CURDIR)" bash "$$t" || exit 1; done
|
@for t in $(TESTS); do echo "== $$t"; REPO="$(CURDIR)" bash "$$t" || exit 1; done
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user