From aa2cddac1523ad4df2a93d20fb2ba4f3c80c45b7 Mon Sep 17 00:00:00 2001 From: Daniel Mizsak <62774880+daniel-mizsak@users.noreply.github.com> Date: Thu, 16 Apr 2026 21:40:57 +0200 Subject: [PATCH] Update renovate and prek documentation --- Justfile | 2 +- README.md | 1 - docs/tools/index.md | 3 ++- docs/tools/pre-commit.md | 25 ------------------------- docs/tools/prek.md | 27 +++++++++++++++++++++++++++ docs/tools/renovate.md | 17 +++++++++++++++++ zensical.toml | 3 ++- 7 files changed, 49 insertions(+), 29 deletions(-) delete mode 100644 docs/tools/pre-commit.md create mode 100644 docs/tools/prek.md create mode 100644 docs/tools/renovate.md diff --git a/Justfile b/Justfile index f8f3272..72ce849 100644 --- a/Justfile +++ b/Justfile @@ -63,7 +63,7 @@ megalinter: npx mega-linter-runner --flavor cupcake --env "MEGALINTER_CONFIG=.github/linters/.megalinter.yml" [group("qa-extra")] -pre-commit: +prek: uv run prek run --all-files [group("build")] diff --git a/README.md b/README.md index 9498ca3..4a9b48f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ build status codecov - pre-commit.ci status pypi version license diff --git a/docs/tools/index.md b/docs/tools/index.md index 9824964..8b93609 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -11,7 +11,8 @@ Below is a list of the tools that I use for almost every project. Navigate to th - [Pytest](./pytest.md) - Modern testing framework. - [Nox](./nox.md) - Testing automation framework for multiple Python environments. - [Megalinter](./megalinter.md) - Many-in-one linter solution. -- [Pre-Commit](./pre-commit.md) - Git pre-commit hook manager. +- [Prek](./prek.md) - Git hook manager for pre-commit checks. +- [Renovate](./renovate.md) - Dependency update automation tool. - [Codecov](./codecov.md) - Platform for tracking code coverage. - [Zensical](./zensical.md) - Static site generator for documentation. - [GitHub Pages](./github-pages.md) - Static site hosting service. diff --git a/docs/tools/pre-commit.md b/docs/tools/pre-commit.md deleted file mode 100644 index ae58c60..0000000 --- a/docs/tools/pre-commit.md +++ /dev/null @@ -1,25 +0,0 @@ -# Pre-Commit - -[Pre-Commit](https://pre-commit.com){target} is a git pre-commit hook manager. - -With `pre-commit` a list of checks can be defined that will be executed on the code before it is committed. If the checks fail, the commit is aborted. This ensures that the code being committed follows certain standards, but many programmers also find this limiting. - -The `pre-commit` related settings are defined in the `.pre-commit-config.yaml` file. - - - -!!! info - To use `pre-commit`, it has to be installed in the virtual environment and also added to the git hooks by running `pre-commit install`. - - -Call pre-commit by making a git commit or by running: - -```bash -uv run pre-commit run --all-files -``` - -Or (alternatively) use `just`: - -```bash -just pre-commit -``` diff --git a/docs/tools/prek.md b/docs/tools/prek.md new file mode 100644 index 0000000..50a60f9 --- /dev/null +++ b/docs/tools/prek.md @@ -0,0 +1,27 @@ +# Prek + +[Prek](https://prek.j178.dev/){target} is a git hook manager for pre-commit checks. + +With `prek` a list of pre-commit checks can be defined that will be executed on the code before it is committed. If the checks fail, the commit is aborted. This ensures that the code being committed follows certain standards, but many programmers also find this limiting. + +The `prek` related settings are defined in the `.pre-commit-config.yaml` file. + + + +!!! info + To use `prek`, it has to be installed in the virtual environment and also added to the git hooks by running `prek install`. + + +Call `prek` by making a git commit or by running: + +```bash +uv run prek run --all-files +``` + +Or (alternatively) use `just`: + +```bash +just prek +``` + +I used to use [pre-commit](https://pre-commit.com){target} before, but switched to `prek` as it seems to be more actively maintained. diff --git a/docs/tools/renovate.md b/docs/tools/renovate.md new file mode 100644 index 0000000..0124d8e --- /dev/null +++ b/docs/tools/renovate.md @@ -0,0 +1,17 @@ +# Renovate + +[Renovate](https://docs.renovatebot.com/){target} is a dependency update automation tool. + +It scans the repository configuration and opens pull requests when supported dependencies can be updated. This keeps the project dependencies current without having to manually track new releases. + +The `renovate` related settings are defined in the `.github/renovate.json5` file. + +In this template I use `renovate` to update: + +- `github-actions` dependencies, +- `pep621` dependencies from `pyproject.toml`, +- `pre-commit` dependencies from `.pre-commit-config.yaml`. + +I also prefer grouping updates by manager and waiting at least 7 days before new releases are updated. + +`Renovate` is used as a [GitHub App](https://github.com/apps/renovate){target}. Once it is installed for the repository, it will automatically read the configuration and start opening pull requests. diff --git a/zensical.toml b/zensical.toml index 73fad17..c0ec78f 100644 --- a/zensical.toml +++ b/zensical.toml @@ -24,7 +24,8 @@ { "Pytest" = "tools/pytest.md" }, { "Nox" = "tools/nox.md" }, { "Megalinter" = "tools/megalinter.md" }, - { "Pre-Commit" = "tools/pre-commit.md" }, + { "Prek" = "tools/prek.md" }, + { "Renovate" = "tools/renovate.md" }, { "Codecov" = "tools/codecov.md" }, { "Zensical" = "tools/zensical.md" }, { "GitHub Pages" = "tools/github-pages.md" },