Ruff 0.11.1 is incorrectly printing the following types of errors:

pmb/helpers/logging.py:169:34: SyntaxError: Cannot use star annotation on Python 3.10 (syntax was added in Python 3.11)
    |
169 | def critical(msg: object, *args: str, **kwargs: Any) -> None:
    |                                  ^^^
170 |     logging.critical(msg, *args, **kwargs)
    |

But the code works fine in Python 3.10 (see pytest-python3.10 CI job).
This is a known upstream bug, pin to the previous version until it is
fixed.

Related: https://github.com/astral-sh/ruff/issues/16874
Part-of: !2578

Part-of: !2568

Add the cross compiling documentation to the pmbootstrap docs.

This is based on the following wiki pages, but updated to reflect new
changes with cross-native2 and to make it more readable:
* https://wiki.postmarketos.org/wiki/Pmbootstrap/Cross_Compiling
* https://wiki.postmarketos.org/wiki/Build_internals#Cross-compile_types



Co-authored-by: Caleb Connolly <caleb@postmarketos.org>

Don't try to modify a variable in the while loop, as it runs in a
subshell because of the pipe. Fail on the first error instead, like we
have it in .ci/shellcheck.sh.

This can be optimized later on (for both scripts) if we really want to.

Fix for:

  In ./.ci/markdown.sh line 17:
  	markdownlint-cli "$file" || MDL_FAILED=1
                                      ^--------^ SC2030 (info): Modification of MDL_FAILED is local (to subshell caused by pipeline).
  In ./.ci/markdown.sh line 20:
  if [ "$MDL_FAILED" = "1" ]; then
        ^---------^ SC2031 (info): MDL_FAILED was modified in a subshell. That change might be lost.

Move the "npm install" command to the section that runs as regular user
instead of root. Instead of creating a /usr/bin/markdownlint-cli
symlink, run the JS file from the path where npm installs it. Try to
find a markdownlint-cli executable and use it instead if it exists, in
case users run this script outside of "pmbootstrap chroot" and have the
linter installed under that name.

Casey authored 5 months ago and Oliver Smith committed 2 months ago

Add a pre-commit hook that runs ruff.sh and tells you how to auto-fix
issues, add a section to CONTRIBUTING.md to document it.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

Casey authored 5 months ago and Oliver Smith committed 2 months ago

Add a CI job to enforce markdown linting

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

Newbyte authored 3 months ago and Oliver Smith committed 3 months ago

The Alpine version is too outdated.

Newbyte authored 3 months ago and Oliver Smith committed 3 months ago

As of 139c2054, we ignore F401 in
__init__.py through the pyproject.toml configuration file, so we don't
need to treat it differently here in the CI script too.

Anri Dellal authored 4 months ago and Newbyte committed 4 months ago

Add module that provides utilities and information related to localization.

Initial implementation includes code to generate keyboard configs
for locale set by user.

Casey authored 5 months ago and Oliver Smith committed 4 months ago

This test includes a binary blob which we want to avoid in our codebase.

It is also better suited as a unit test where it can contribute to code
coverage. Revert this and use a unit test version instead.

This reverts commit d19de946.

Signed-off-by: Robert Eckelmann <longnoserob@postmarketos.org>

Make sure we don't regress in "pmbootstrap zap -a" by running it after
each integration test.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

Refactor the integration test script to support running a variety of
tests, and add CI jobs for them.

Additionally, move the integration tests to their own stage so we don't
potentially waste a bunch of CI time running them on broken branches.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

This is already the default: https://mypy.readthedocs.io/en/stable/config_file.html#confval-color_output

And remove --check-untyped-defs from mypy.sh script to avoid
duplication.

Luca Weiss authored 5 months ago and Casey committed 5 months ago

We now run the job in chroot, so remove the unnecessary check. If
sphinx-build is missing for some reason, it will fail a bit further in
the script anyways.

So we don't go through the pain of pushing 3 times to get 3 different
ruff failures in CI.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

Luca Weiss authored 6 months ago and Casey committed 5 months ago

* Make sure all Python modules are documented by adding a bit of shell
  to .ci/docs.sh
* Remove non-existing module references from .rst
* Fix various warnings from sphinx by adjusting Python docstrings
* Add class member docs to ApkindexBlock

Use the new "Artifacts" directive for .ci/docs.sh and run the job in the
pmbootstrap chroot to avoid needing to install sphinx dependencies on
the host.

Fixes #2352

All typing errors found with --check-untyped-defs have been fixed, so
let's make mypy stricter now to avoid regressing this.

Newbyte authored 6 months ago and Newbyte committed 6 months ago

Alpine stable's mypy is currently outdated and has bugs in its
handling of overloads. As such, just use mypy from pip so we don't have
to worry about working aroud bugs in old mypy versions.

[ci:skip-build]: already built successfully in CI

Makes errors easier to read between hints and warnings.

Let's write all new documentation in markdown, and convert existing ones
at some point. I think we are all much more familiar with markdown than
with the rst format.

Hugo Barrera authored 9 months ago and Oliver Smith committed 9 months ago

Fixes: https://gitlab.com/postmarketOS/pmbootstrap/-/issues/2324

Hugo Barrera authored 9 months ago and Oliver Smith committed 9 months ago

Python 3.9 was required in pmb/__init__.py already, but some references
still said 3.8 and 3.7.

Co-Developed-By: Oliver Smith <ollieparanoid@postmarketos.org>

Casey authored 10 months ago and Oliver Smith committed 9 months ago

Adjust the pytest CI to work with the new tests.

It's useful to run pytest even when linters fail, so set allow_failure
for the lint jobs.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

Oliver Smith authored 1 year ago and Newbyte committed 1 year ago

Fix for:
warning: `ruff <path>` is deprecated. Use `ruff check <path>` instead.

Reviewed-by: Luca Weiss <luca@z3ntu.xyz>
Link: https://lists.sr.ht/~postmarketos/pmbootstrap-devel/%3C20230706211537.10438-3-ollieparanoid@postmarketos.org%3E

Luca Weiss authored 1 year ago and Oliver Smith committed 1 year ago

It has happened more than once that Python 3.9+ type annotation have
slipped into the code and broken earlier Python versions. Enable the
eval-annotations flag in vermin to catch that.

Reviewed-by: Oliver Smith <ollieparanoid@postmarketos.org>
Link: https://lists.sr.ht/~postmarketos/pmbootstrap-devel/%3C20230625193650.528651-2-luca@z3ntu.xyz%3E