Can you move this to a decision request? (https://www.mediawiki.org/wiki/Wikimedia_Cloud_Services_team#Decision_making)

Some things to keep in mind:

• Offer more than one option (ex. using pre-commit + tox, using scripts + tox, using only tox, using only scripts, ...)
• Try to describe the same aspects for every option (ex. usability (installation, usage, maintenance), open-source, effort required, ...)
• One of the options should be "staying as we are" kind of thing

In T320234#8310215, @dcaro wrote:

Can you move this to a decision request? (https://www.mediawiki.org/wiki/Wikimedia_Cloud_Services_team#Decision_making)

I'm on it. Thanks for the pointers.

To avoid writing too long a commit message, I'm detailing the changes here for reference:

• The specific configuration of each tool can be found in either pyproject.toml, or in tox.ini for flake8, which still (!) has no compatibility with pyproject.toml. This is just as before – no changes here.
• The main difference is that all the commands are now run using pre-commit. Pre-commit creates its own environment for each tool, installs the project dependencies with poetry, and runs the tool. The way and order in which the tools are run is configured inside .pre-commit-config.yaml.
• A few common checks/lints have been added:
  • removal of trailing whitespace
  • making sure each file ends with an empty line
  • a toml checker
  • a yaml checker
• All the tools pre-commit runs are the latest version. This needs to be updated from time to time by running poetry run pre-commit autoupdate locally.
• I've set the Python version to 3.10 for all checks. This was a somewhat arbitrary choice, and can easily be changed. Or, kind of – there's a bug when running the latest version of flake8 with Python 3.7, for which the fix is to either upgrade the Python version, or downgrade flake8.
• As mentioned above, pre-commit takes care of all its dev dependencies, so these have been removed from pyproject.toml. Tools that need additional dependencies, such as mypy (types-requests, types-PyYAML...), have these defined inside .pre-commit-config.yaml.

Unrelated to pre-commit, all dev dependencies inside pyproject.toml have been moved to [tool.poetry.group.dev.dependencies], as the old section naming is about to become deprecated.

Change 868332 had a related patch set uploaded (by Slavina Stefanova; author: Slavina Stefanova):

[cloud/toolforge/toolforge-cli@main] dev: Use pre-commit for code-quality checks

https://gerrit.wikimedia.org/r/868332

Change 868332 merged by jenkins-bot:

[cloud/toolforge/toolforge-cli@main] dev: Use pre-commit for code-quality checks

https://gerrit.wikimedia.org/r/868332