Changelog¶

9.1.0 (2026-11-08)¶

✨ Features¶

cli: add 'mise.toml' to '--configure' staged configurations (236e9a6)
src, requirements: migrate to 'commitizen' 4.19.3+adriandc.20261108 (4fc9dc7)

🐛 Bug Fixes¶

commands: detect unresolved 'mise' shims as missing binaries (b4fed32)

⚙️ Cleanups¶

mise: add 'commitizen' 4.19.3+adriandc.20261108 and 'prek' (8dba98e)

9.0.2 (2026-11-08)¶

🐛 Bug Fixes¶

commitizen: handle invalid 'cz version' output as incompatible (377ef0e)

🧪 Test¶

mise, commands: remove coverage of 'mise' environment specific sources (3dc9189)

9.0.1 (2026-11-08)¶

🐛 Bug Fixes¶

cli: discard rejected '.pre-commit-config.yaml' changes in '--patch' mode (44a8f01)

9.0.0 (2026-11-07)¶

✨ Features¶

cli: implement '--stage' GitLab CI stage with '--configure' (a809a4e)
cli: use 'refresh with' commit title if version is unchanged (cb2e444)
cli: add '-p, --patch' to add configurations with 'git add --patch' (69146ba)
commits: install 'mise-en-place' in the 'commits' container (deaac25)
configurations: add 'chore(mise)' matchers for 'mise' configurations (743500e)
mise: install dependencies with 'mise' if running from 'mise' (74843c2)
mise: install dependencies in the 'mise' configuration of the tool (540226d)
mise: avoid '--path' if already the default 'mise use' configuration (0974008)
updates: show 'mise use' update command if running from 'mise' (0be618a)
updates: show 'mise use' update in the 'mise' configuration of the tool (686c2df)

🐛 Bug Fixes¶

bundle: resolve 'assets' resources from the running package (8c757c4)
gitlab-ci: import 'assets' sources files before 'coverage' jobs (0832f86)
precommit: parse 'prek' hooks stages from '--stage' help (e2d109a)

📚 Documentation¶

mkdocs: exclude generated pages from 'git-revision-date-localized' (fa4d3e5)
mkdocs: exclude 'commits.generated.md' from 'git-revision-date-localized' (3b6b579)
readme: add 'mise-en-place' badge header (a0d8636)
readme, prepare: link 'pipeline' badges to GitLab CI pipelines page (1621434)

🧪 Test¶

stages: implement '--stage' configure and hooks stages tests (a5be941)

⚙️ Cleanups¶

cliff: migrate 'cliff.toml' to 'conf/git-cliff/' folder (5ec0b19)
mise: create 'menu:gcil' task for 'gcil' use cases (97a8e21)
mise: create 'changelog' task to generate with 'git-cliff' (88e0dbc)
mise: create 'pull' task to pull upstream sources (56d7f90)
pre-commit: refresh with 'pre-commit-crocodile' 8.4.0 (4d2342d)

🚀 CI¶

gitlab-ci: wait for 'registry:commits' to run 'commits' (ca782b0)
gitlab-ci: remove 'changelog' job as generated with 'git-cliff' mise task (e3a7e69)
gitlab-ci: migrate to 'RadianDevCore/gitlab-ci/components' 2.0.0 (8cb513d)

📦 Build¶

pages: install 'git-cliff' 2.14.1 through 'mise' from 'extrepo' (59f1d4a)

8.4.0 (2026-09-12)¶

✨ Features¶

cli: deprecate default engine warning in favour to 'prek' (0abe31c)
pre-commit-config: migrate to 'prek' 0.5.2 (f9ca9c4)
pre-commit-config: migrate to 'pre-commit' 4.6.2 (8781ff2)
pre-commit-config: migrate to 'commitizen' 0.18.0 (3285557)
pre-commit-config: migrate to 'gcil' 13.1.0 (3493d7c)

⚙️ Cleanups¶

mise: create 'mise-en-place' configuration for 'gcil' (923744b)
mise: require 'pre-commit-crocodile' dependency and activation (ed396ac)
mise: alias 'make' to 'gcil' for generic use cases (9155b33)

📦 Build¶

requirements: migrate to 'uv' 0.12.13 (872b5ef)

8.3.0 (2026-08-21)¶

✨ Features¶

pre-commit-config: migrate to 'prek' 0.4.14 (e93f19a)
precommit: implement support for 'prek' installed with 'mise' (da02b00)

🐛 Bug Fixes¶

🚨 BREAKING CHANGE 🚨 | updates, requirements: migrate to 'update_checker' 1.0.0 API (2c09921)

📚 Documentation¶

license, mkdocs: raise copyright year to 2026 (7b67179)

🎨 Styling¶

environments: resolve dictionary values iterator (python:S7512) (d52501f)
src: migrate to '|' types unions (python:S6546) (e5220a8)

⚙️ Cleanups¶

updates: enforce 'typings' [arg-type] error on 'date' (6d29635)

📦 Build¶

🚨 BREAKING CHANGE 🚨 | gitlab-ci, setup: raise oldest Python from 3.9 to 3.10 (ae8567c)
🚨 BREAKING CHANGE 🚨 | gitlab-ci, setup: raise latest Python from 3.13 to 3.14 (377f742)

8.2.1 (2025-12-27)¶

✨ Features¶

pre-commit: exclude NPM lock files from large files checks (91e6652)

🚀 CI¶

commits: skip job when running on schedule (36173d3)

8.2.0 (2025-09-19)¶

⚙️ Cleanups¶

commitizen: apply YAML codestyle improvements (a8c4c95)
commitizen: add missing documentation for 'revert' (ec680c1)
commitizen: sort commits type regex in the same order (d0ec280)
commitizen: implement 'deps' for dependencies related commits (bb33d08)

🚀 CI¶

commits: implement 'validate_merge_commits' CI/CD input (56fb175)

8.1.0 (2025-09-16)¶

🚀 CI¶

commits: disable 'set -x' verbose execution logs (e012b91)
commits: implement 'validate_commitizen_config' CI/CD input (ba5d5e5)
commits: implement 'validate_commitizen_range' CI/CD input (14eee9d)
commits: implement 'validate_hooks_checks' CI/CD input (a507ec3)
commits: implement 'validate_duplicated_commits' CI/CD input (08da916)
commits: implement 'validate_wip_commits' CI/CD input (dcd6e6a)

8.0.1 (2025-09-15)¶

✨ Features¶

pre-commit-config: migrate to 'prek' 0.2.1 (5663ddf)

🐛 Bug Fixes¶

precommit: resolve 'pip install PACKAGE1 PACKAGE2' usage (cfe7274)

🚀 CI¶

commits: upgrade engine if older than 'minimum_{pre_commit,prek}_version' (d78936a)
gitlab-ci: use '$CI_SERVER_FQDN/$CI_PROJECT_PATH' for forks (5ba2f44)
gitlab-ci: resolve 'CI_COMMIT_REF_NAME' quoting syntax (c32a8a8)
gitlab-ci: disable 'quality:sonarcloud' without 'SONAR_{HOST_URL,TOKEN}' (bad88bd)

8.0.0 (2025-09-14)¶

✨ Features¶

cli: implement 'includes: remotes:' support and '--remotes' (c640cb4)
pre-commit-config: migrate to 'prek' 0.2.0 (efaec2a)
pre-commit-config: migrate to 'commitizen' v4.9.1 (731a152)
pre-commit-config: migrate to 'gcil' 13.0.1 (0d76eef)
precommit: migrate to 'prek auto-update' usage (9e7da0f)
precommit: configure 'prek' as default engine (e172dd6)
src, requirements: migrate to 'commitizen' 4.9.1+adriandc.20250914 (b46a211)

🐛 Bug Fixes¶

assets: isolate template as '.pre-commit-config.template.yaml' (4188926)

📚 Documentation¶

components: document 'include: remote:' syntax usage (c415801)
readme: document engine settings configuration (0b88412)
readme: improve documentation to document provided features (8d4c424)
readme: move 'prek' default engine first (c9401ea)

⚙️ Cleanups¶

assets: use 'PACKAGE_REVISION' simpler text syntax (b24ae12)

🚀 CI¶

commits: configure 'prek' as default engine (d07cd24)
commits: detect duplicated commits titles in checked ranges (b675527)

📦 Build¶

commits: raise minimal image version to '7' (57e2fa3)

7.0.0 (2025-08-14)¶

✨ Features¶

cli, features: implement 'prek' engine 'pre-commit' alternative (e369d7e)
features: add support for multiple 'PACKAGES' dependencies (91d1b0e)
main: implement '--set-engine' to set 'pre-commit' or 'prek' (1db9afa)
main: add 3 seconds warning if engine setting is not done (305a999)
pre-commit: migrate 'minimum_prek_version' to 0.0.25 (db06b79)
precommit: add support for 'prek run' output parsing (ac36ae3)
src: isolate 'pre-commit' and 'commitizen' titles to constants (16ab56f)

🐛 Bug Fixes¶

main: show engine warning only without a critical result (f111b40)
main, colors: use '‣' symbol only in UTF-8 terminals (bdfce45)
version: enforce against digit only revision with 'x.y.z[-N-gSHA]' (b9f5983)

📚 Documentation¶

readme: document 'prek' and 'uv' as being use (747ad94)
readme, docs, setup, bundle: improve description with 'prek' (b0d4d6e)

🚀 CI¶

commits: avoid 'install --install-hooks' upon local jobs (c4aa944)
gitlab-ci: bind 'commits' job locally for validation tests (d243212)

📦 Build¶

commits: implement 'prek' optional 'pre-commit' engine (3c5f33d)
commits: optimize Rust compiler caches out of the image (e132755)
containers/rehost: revert to Debian 12 'python:3.13-slim-bookworm' (287673a)
requirements: upgrade to 'playwright' 1.54.0 (bd5fa6d)
requirements: install 'prek' 0.0.25 and 'uv' 0.8.10 (1199962)

6.2.1 (2025-08-13)¶

✨ Features¶

entrypoint: create missing 'README.md' if '--badges' used (1352f4b)

🐛 Bug Fixes¶

entrypoint: avoid 'git commit' if no differences added (6174883)
entrypoint: add missing '--badge' header and output flushes (8fa468b)
entrypoint: re-inject partially missing badges properly (1117ea3)
entrypoint: resolve unreliable 'README.md' badges line endings (a46036e)
main: avoid '--configure' if '--commit' is used with '--badges' (f7ee29a)

🚀 CI¶

gitlab-ci: remove redundant 'before_script:' references (41fae52)

6.2.0 (2025-08-11)¶

✨ Features¶

entrypoint, features: fix configure without 'git' repository (6719a65)
main: automatically imply '--configure' if '--commit' is used (0105b4a)
pre-commit-config: migrate to 'pre-commit-hooks' v6.0.0 (f8b3d22)
pre-commit-config: migrate to 'gcil' 13.0.0 (17f7069)

🐛 Bug Fixes¶

check_commitizen_branch: ignore missing remote branches (f6ba7b4)
entrypoint: register '.gitlab-ci.yml' file configurations (655b243)
entrypoint: resolve handlings of empty 'README.md' file (d877ba0)
entrypoint, git: resolve diff on untracked files with intend add (a97c10d)

🚀 CI¶

commits: implement 'skip' CI/CD input to exclude pre-commit hooks (3235ab4)
gitlab-ci: implement GitLab tags protection jobs (cf6f446)

📦 Build¶

commits: install 'git-lfs' in the 'commits' image (15c48e3)
commits: install 'bash' in the 'commits' image (e76a933)

6.1.0 (2025-07-29)¶

🚀 CI¶

commits: validate 'commits' minimal image version (abb3fbb)
commits: resolve '.git/hooks' user ownerships (3a3601b)

📦 Build¶

containers/commits: install 'coreutils' for 'chown --reference' (e71b38c)
containers/commits: create '/VERSION' version marker file (ed76432)

6.0.0 (2025-07-21)¶

✨ Features¶

cli: implement '--components' to force online components (3687cc1)
cli, git: detect 'gitlab.com' remote to configure local components (01f7d0c)
commitizen: ensure single space after 'type(scope):' (4d80a55)
entrypoint: improve '--configure' output delays timings (e56496c)
entrypoint: run 'pre-commit autoupdate' upon configuration (bcfe530)
entrypoint: prepare '.gitlab-ci.yml' configuration for 'stages' (c731e3e)
entrypoint: enable 'pre-commit' after '--configure' steps (9ea730d)
entrypoint: implement components binding to '.gitlab-ci.yml' (0b2a028)
entrypoint: avoid Commitizen check calls without commits (0fd63d3)
entrypoint, git: avoid 'git commit' if no differences added (3a34920)
entrypoint, git: avoid Git sources hints if no differences (11c0fa4)
entrypoint, precommit: disable configurations hooks for users (85ab407)
hooks, pre-commit: implement 'check-commitizen-branch' wrapper (e0b148f)
pre-commit-config: migrate to 'pre-commit-hooks' v5.0.0 (83ae2a3)
pre-commit-config: migrate to 'commitizen' v4.8.3 (6e4fa36)
setup: add support for Python 3.13 (7386afd)

🐛 Bug Fixes¶

commitizen: ignore error '23' if checking non-existing ranges (a0056cd)
configurations: resolve support for files starting with '.' or '_' (06dde1f)
configurations: fixup 'LICENSE', 'README', 'CHANGELOG' matchers (71fb3f1)
entrypoint: resolve Git commit command hints (52c3f5d)
pre-commit: resolve deprecate 'pre-commit' stages names (fa278b1)
pre-commit-config: ignore remotes without 'set-head -a' (7db090c)

📚 Documentation¶

mkdocs: embed coverage HTML page with 'mkdocs-coverage' (cec6d3d)
prepare: prepare empty HTML coverage report if missing locally (73cbba8)
readme: document 'mkdocs-coverage' plugin in references (284b684)

🎨 Styling¶

precommit: create 'HOOK_...' constants for reuse (6189105)

🧪 Test¶

platform: improve coverage for Windows target (016f7c6)

⚙️ Cleanups¶

gitlab-ci, docs, src: resolve non breakable spacing chars (35fccd6)
strings: remove unused 'random' method and dependencies (04ec7b9)

🚀 CI¶

gitlab-ci: bind coverage reports to GitLab CI/CD artifacts (f2ab6a9)
gitlab-ci: configure 'coverage' to parse Python coverage outputs (c90c1a7)
gitlab-ci: always run 'coverage:*' jobs on merge requests CI/CD (e0cbbbb)
gitlab-ci: show coverage reports in 'script' outputs (24fcdf0)
gitlab-ci: restore Windows coverage scripts through templates (bf85f89)
gitlab-ci: resolve 'coverage' regex syntax for Python coverage (c99b19d)
gitlab-ci: resolve 'coverage:windows' relative paths issues (1f98024)
gitlab-ci: run normal 'script' in 'coverage:windows' with 'SUITE' (101b4ba)
gitlab-ci: use 'before_script' from 'extends' in 'coverage:*' (527d924)
gitlab-ci: run 'versions' tests on 'coverage:windows' job (ead73e3)
gitlab-ci: fix 'pragma: windows cover' in 'coverage:linux' (7350ef1)
gitlab-ci: run 'colors' tests in 'coverage:windows' (7c6cf41)
gitlab-ci: add 'pragma: ... cover file' support to exclude files (154b070)
gitlab-ci: isolate 'pages' and 'pdf' to 'pages.yml' template (302293f)
gitlab-ci: isolate 'deploy:*' jobs to 'deploy.yml' template (5c46db3)
gitlab-ci: isolate 'sonarcloud' job to 'sonarcloud.yml' template (8364828)
gitlab-ci: isolate 'readme' job to 'readme.yml' template (ce6ab32)
gitlab-ci: isolate 'install' job to 'install.yml' template (eee29b1)
gitlab-ci: isolate 'registry:*' jobs to 'registry.yml' template (3648720)
gitlab-ci: isolate 'changelog' job to 'changelog.yml' template (fef22df)
gitlab-ci: isolate 'build' job to 'build.yml' template (b048157)
gitlab-ci: isolate 'codestyle' job to 'codestyle.yml' template (e9067d2)
gitlab-ci: isolate 'lint' job to 'lint.yml' template (311b16c)
gitlab-ci: isolate 'typings' job to 'typings.yml' template (9e9a91a)
gitlab-ci: create 'quality:coverage' job to generate HTML report (251d92c)
gitlab-ci: cache HTML coverage reports in 'pages' (3644fa3)
gitlab-ci: migrate to 'quality:sonarcloud' job name (8823190)
gitlab-ci: isolate 'clean' job to 'clean' template (52ffbd2)
gitlab-ci: deprecate 'hooks' local job (cd2ad39)
gitlab-ci: use more CI/CD inputs in 'pages.yml' template (e2c5265)
gitlab-ci: isolate 'preview' to 'preview.yml' template (62573ba)
gitlab-ci: isolate '.test:template' to 'test.yml' template (b39091c)
gitlab-ci: isolate '.coverage:*' to 'coverage.yml' template (1c494fc)
gitlab-ci: raise latest Python test images from 3.12 to 3.13 (3365d45)
gitlab-ci: migrate to RadianDevCore components submodule (9a9dc89)
gitlab-ci: isolate Python related templates to 'python-*.yml' (fa28d12)
gitlab-ci: migrate to 'git-cliff' 2.9.1 and use CI/CD input (3d17254)
gitlab-ci: create 'paths' CI/CD input for paths to cleanup (fb425b0)
gitlab-ci: create 'paths' CI/CD input for paths to format (c6459b3)
gitlab-ci: create 'paths' CI/CD input for paths to check (0a8da54)
gitlab-ci: create 'paths' CI/CD input for paths to lint (2d78cb2)
gitlab-ci: create 'intermediates' and 'dist' CI/CD inputs (d04cb26)

📦 Build¶

pages: install 'coverage.txt' requirements in 'pages' image (e28dc56)
requirements: install 'mkdocs-coverage>=1.1.0' for 'pages' (72fb372)

5.1.0 (2025-06-09)¶

✨ Features¶

cli: implement '--no-components' to import 'commits.yml' template (c3a6999)
gcil: raise minimal 'gcil' version to 12.0.0 (0ac2606)
templates: refactor '--no-components' with 'spec: inputs:' (c2f7365)

⚙️ Cleanups¶

cz: migrate from 'multiple_line_breaker' to 'break_multiple_line' (8068901)

🚀 CI¶

gitlab-ci: migrate to 'CI_LOCAL_*' variables with 'gcil' 12.0.0 (e8cdad9)

5.0.0 (2025-06-08)¶

✨ Features¶

cli: add '--commit' to automatically commit '--configure' changes (6f4dd94)
cli, gcil: implement '--offline' to disable initial autoupdate (bd1ef50)
commitizen: migrate to 'AdrianDC/commitizen' sources tag (7a925bc)
entrypoint: improve '--configure' command hints for updates (659cc3e)
entrypoint: run '--run' steps in '--enable' if supported (ab1720c)
requirements, src: migrate to 'commitizen' 4.8.2+adriandc.20250608 (ffd5ea9)
src: refactor section headers style and look closed to 'gcil' (1b34aef)

🐛 Bug Fixes¶

version: migrate from deprecated 'pkg_resources' to 'packaging' (314bf0d)
version: try getting version from bundle name too (79450cf)

📚 Documentation¶

commits: document 'cz commit --edit' syntax (e848a43)

⚙️ Cleanups¶

pre-commit-config: explicit 'commit-msg' stage for 'commitizen' (adc0f35)
vscode: install 'ryanluker.vscode-coverage-gutters' (1f44dbb)
vscode: configure coverage file and settings (641d6af)

🚀 CI¶

coveragerc, gitlab-ci: implement coverage specific exclusions (2badbc5)
gitlab-ci: improve combined coverage local outputs (2b31171)
gitlab-ci: enforce 'coverage' runs tool's 'src' sources only (9bdf726)
gitlab-ci: add support for '-f [VAR], --flag [VAR]' in 'readme' (8396c68)

📦 Build¶

requirements: add 'importlib-metadata' runtime requirement (43f298f)

4.2.1 (2025-05-31)¶

🐛 Bug Fixes¶

precommit: fix mismatching excludes upon '--configure' (039a2da)

4.2.0 (2025-05-31)¶

✨ Features¶

entrypoint: avoid 'sleep' calls without user input TTY (e3ecb29)
pre-commit-config: exclude '.md' files from 'trailing-whitespace' (db98cc2)

🐛 Bug Fixes¶

pre-commit: fix empty hooks with 'hooks: []' upon '--configure' (3ef9cbe)

⚙️ Cleanups¶

pre-commit: migrate to 'gcil' 10.2.0 (257ec3a)

🚀 CI¶

gitlab-ci: remove unrequired 'stage: deploy' in 'pdf' job (e07a8f2)

4.1.0 (2025-05-31)¶

✨ Features¶

configurations: implement support for '.gitmodules' files (f4f452d)
configurations: implement support for 'Dockerfile' files (dfb036c)
configurations: add support for 'scripts/' commit messages (274516d)

🐛 Bug Fixes¶

hooks: resolve changes detection for 'path.ext -> path.ext2' (6a53954)

📚 Documentation¶

license, mkdocs: raise copyright year to '2025' (ba17df1)
prepare: avoid 'TOC' injection if 'hide: - toc' is used (b6664ff)

🎨 Styling¶

colors: ignore 'Colored' import 'Incompatible import' warning (6b04f76)

⚙️ Cleanups¶

sonar-project: configure coverage checks in SonarCloud (e526d65)

🚀 CI¶

commits: disable submodules clone with 'GIT_SUBMODULE_STRATEGY' (87e2b11)
commits: ensure './.cz.yaml' is always being used by 'git cz' (d7038a5)
gitlab-ci: ensure 'pages' job does not block pipeline if manual (b4ed026)
gitlab-ci: change release title to include tag version (a9a8a53)
gitlab-ci: run coverage jobs if 'sonar-project.properties' changes (cca4330)
gitlab-ci: watch for 'docs/.*' changes in 'pages' jobs (582f84f)

4.0.0 (2025-01-01)¶

✨ Features¶

cli: implement '--badges' option as partial '--configure' (a63468f)
cli: inject RadianDevCore Guidelines badge automatically (fef9c67)
commitizen: accept '[Ww][Ii][Pp]' types without casing (9d85387)
configurations: add matchers for 'tsconfig.json' files (72fa06e)
hooks: implement 'check-yaml-ruamel-pure' hook with pure 'ruamel.yaml' (295b39b)
hooks: handle 'res' and 'resources' in 'prepare-commit-message' (37c5854)
pre-commit: exclude Vivado '.vhd', '.xci' and '.xdc' files (fe8ffab)
pre-commit: exclude '.nmconnection' from 'check-case-conflict' (60cde89)
pre-commit-config: enable 'check-yaml' by default (906d11c)
pre-commit-config: enable 'detect-private-key' by default (6c3222b)
pre-commit-config: exclude 'archives/' root folder from cz checks (0ea05c4)
prepare_commit_message: always lowercase the commit's scope (69a8510)

🐛 Bug Fixes¶

cli: use package name for 'Updates' checks (3d6c4c5)
configurations: fix '.' regex syntaxes in 'prepare_commit_message' (be01676)
git: fetch the remote before updating remote HEAD pointers (2c1713f)
main: ensure 'FORCE_COLOR=0' if using '--no-color' flag (a1d79e4)
pre-commit: add missing 'commit-msg' stage for commitizen (24af224)
pre-commit-config: disable 'check-yaml' hook by default (cda428c)
pre-commit-config: exclude '.drawio' files from 'pre-commit' (74398c5)
pre-commit-config: resolve 'README.md' regex file name (08154eb)

📚 Documentation¶

assets: prepare mkdocs to generate mermaid diagrams (41cf08a)
commits: isolate generated documentation into included file (bdc1796)
covers: resolve broken page header / footer titles (b3b6906)
custom: change to custom header darker blue header bar (06623e7)
docs: migrate to page breaks using 'span' elements (8828f38)
docs: improve documentation PDF outputs with page breaks (7e287ba)
hooks: refactor and improve 'check-yaml-ruamel-pure' documentation (77e7662)
mkdocs: enable 'git-revision-date-localized' plugin (3b055c0)
mkdocs: change web pages themes colors to 'blue' (5d504b6)
mkdocs: fix 'git-revision-date-localized' syntax (151d0f9)
mkdocs: migrate to 'awesome-pages' pages navigation (f1ec64b)
mkdocs: change 'auto / light / dark' themes toggle icons (1113338)
mkdocs: enable and configure 'minify' plugin (39236c6)
mkdocs: install 'mkdocs-macros-plugin' for Jinja2 templates (a898280)
mkdocs: enable 'pymdownx.emoji' extension for Markdown (8289f48)
mkdocs: implement 'mkdocs-exporter' and customize PDF style (66cb7ff)
mkdocs: set documentation pages logo to 'solid/code' ('</>') (7a57a85)
mkdocs: enable 'permalink' headers anchors for table of contents (82d4019)
mkdocs: prepare 'privacy' and 'offline' plugins for future usage (86bd751)
mkdocs: disable Google fonts to comply with GDPR data privacy (8d369d8)
mkdocs: implement 'Table of contents' injection for PDF results (7fa333e)
mkdocs: enable 'Created' date feature for pages footer (59237fd)
mkdocs: add website favicon image and configuration (f740eda)
mkdocs: implement 'book' covers to have 'limits' + 'fronts' (32ac6a1)
mkdocs: isolate assets to 'docs/assets/' subfolder (d6e55e3)
mkdocs: exclude '.git' from watched documentation sources (524010c)
mkdocs: minor '(prefers-color-scheme...)' syntax improvements (82efc4c)
mkdocs, pages: use 'MKDOCS_EXPORTER_PDF_OUTPUT' for PDF file (890acf6)
pages: rename index page title to '‣ Usage' (25fd14f)
pages: rename PDF link title to 'Export as PDF' (13e5bc2)
pdf: simplify PDF pages copyright footer (371c84a)
pdf: migrate to custom state pseudo class 'state(...)' (f3bdb3c)
pdf: avoid header / footer lines on front / back pages (ea28186)
pdf: minor stylesheets codestyle improvements (5800649)
pdf: reverse PDF front / back cover pages colors for printers (cf420dd)
prepare: avoid 'md_in_html' changes to 'changelog' and 'license' (e82ff9e)
prepare: fix '<' and '>' changelog handlings and files list (d13f57f)
prepare: implement 'About / Quality' badges page (3180bdb)
prepare: improve 'Quality' project badges to GitLab (7624936)
prepare: use 'docs' sources rather than '.cache' duplicates (121c343)
prepare: resolve 'docs/about' intermediates cleanup (0e09ba4)
prepare: add PyPI badges and license badge to 'quality' page (28950ac)
prepare: avoid adding TOC to generated and 'no-toc' files (e9c6231)
prepare: use 'mkdocs.yml' to get project name value (3b8b36b)
readme: add pypi, python versions, downloads and license badges (2747e58)
readme: improve projects documentation for developers (e1d01b5)
robots: configure 'robots.txt' for pages robots exploration (3e3347a)
stylesheets: resolve lines and arrows visibility in dark mode (b2a6c4f)
templates: add 'Author' and 'Description' to PDF front page (920d5d9)
templates: add 'Date' detail on PDF front page (a3c66ee)
templates: use Git commit SHA1 as version if no Git tag found (2348bec)

⚙️ Cleanups¶

bundle, readme: minor codestyle and syntax improvements (cb46ca3)
gitignore: exclude only 'build' folder from sources root (339d183)
gitignore: exclude '/build' folder or symlink too (28b7a69)
hooks: resolve 'too-many-positional-arguments' new lint warnings (c30f7fc)
pre-commit: disable 'check-useless-excludes' hook (75f8ec3)
pre-commit: exclude '.drawio' diagrams and images files (0773900)
vscode: use 'yzhang.markdown-all-in-one' for Markdown formatter (533b56d)

🚀 CI¶

build: add missing 'containers/build/Dockerfile' to tracked files (3f07bc8)
commits: minor GitLab CI job logs readability improvements (29eb6f4)
commits: add 'name' component input configuration for job name (d8e274b)
commits: resolve and support single-commit Git histories (f6bf4bb)
commits: validate 'HEAD' has a parent commit through 'git log' (968ca51)
gitlab-ci: enforce 'requirements/pages.txt' in 'serve' job (61e3737)
gitlab-ci: add 'python:3.12-slim' image mirror (daa7287)
gitlab-ci: inject only 'mkdocs-*' packages in 'serve' job (67fa3c2)
gitlab-ci: install 'playwright' with chromium in 'serve' job (cefbcff)
gitlab-ci: improve GitLab CI job outputs for readability (8a8e69f)
gitlab-ci: deploy GitLab Pages on 'CI_DEFAULT_BRANCH' branch (f34cf59)
gitlab-ci: find files only for 'entr' in 'serve' (6c37678)
gitlab-ci: ignore 'variables.scss' in 'serve' watcher (144f35b)
gitlab-ci: preserve only existing Docker images after 'images' (14c2217)
gitlab-ci: use 'MKDOCS_EXPORTER_PDF_ENABLED' to disable PDF exports (c7d38a9)
gitlab-ci: run 'pages' job on GitLab CI tags pipelines (539dcd6)
gitlab-ci: isolate 'pages: rules: changes' for reuse (255bd8f)
gitlab-ci: allow manual launch of 'pages' on protected branches (0cb3464)
gitlab-ci: create 'pdf' job to export PDF on tags and branches (c5e4eba)
gitlab-ci: implement local pages serve in 'pages' job (0864919)
gitlab-ci: raise minimal 'gcil' version to '11.0' (03efbe2)
gitlab-ci: enable local host network on 'pages' job (6f0b6c6)
gitlab-ci: detect failures from 'mkdocs serve' executions (d4d434d)
gitlab-ci: refactor images containers into 'registry:*' jobs (0b69a9b)
gitlab-ci: bind 'registry:' dependencies to 'requirements/.txt' (39e8846)
gitlab-ci: avoid PDF slow generation locally outside 'pdf' job (b556868)
gitlab-ci: validate host network interfaces support (64ac80a)
gitlab-ci: enable '.local: no_regex' feature (dd8a20c)
gitlab-ci: append Git version to PDF output file name (7b318b7)
gitlab-ci: rename PDF to 'pre-commit-crocodile' (1937a42)

📦 Build¶

build: add 'gcc' and 'libc-dev' for pre-commit-hooks v5.0.0 (8c8e17f)
codestyle: add 'gcc' and 'libc-dev' for pre-commit-hooks v5.0.0 (9b52c0d)
commits: add 'gcc' and 'libc-dev' for pre-commit-hooks v5.0.0 (1b86f3c)
pages: migrate to 'python:3.12-slim' Ubuntu base image (5c3936d)
pages: install 'playwright' dependencies for 'mkdocs-exporter' (e44333d)
pages: install 'entr' in the image (d2eb9d1)
requirements: install 'mkdocs-git-revision-date-localized-plugin' (7628aa3)
requirements: install 'mkdocs-awesome-pages-plugin' plugin (abe762c)
requirements: install 'mkdocs-minify-plugin' for ':pages' (7de6f86)
requirements: install 'mkdocs-exporter' in ':pages' (0a6fe7b)
requirements: migrate to 'mkdocs-exporter' with PR#35 (4c74f9a)
requirements: upgrade to 'playwright' 1.48.0 (e41415f)
requirements: migrate to 'mkdocs-exporter' with PR#42/PR#41 (e3c5c26)

3.1.0 (2024-08-25)¶

✨ Features¶

cli: implement '--stage STAGE' for '--run' to specify stage (9ef3d2a)
configurations: implement matcher for 'sonar-project.properties' (b9627a6)
gcil: inject 'gcil' badge automatically if configured or installed (6cfe076)
gcil: implement automatic 'run-gcil-push' hooks with whitelist (56e9e6c)
main: add '-D' as short flag for '--default' long flag (6515c29)
pre-commit: add 'pygrep-hooks' hooks to 'pre-commit' template (8813f81)

🐛 Bug Fixes¶

features: enforce 'Commands' conditional arguments syntax (142108f)

📚 Documentation¶

cliff: improve 'Unreleased' and refactor to 'Development' (abaf0c9)
mkdocs, prepare: resolve Markdown support in hidden '<details>' (d647166)
prepare: regenerate development 'CHANGELOG' with 'git-cliff' (0cc6cc7)
readme: link against 'gcil' and 'pexpect-executor' documentation pages (3044355)
readme: add 'gcil:enabled' documentation badge (f06542b)

⚙️ Cleanups¶

sonar: wait for SonarCloud Quality Gate status (f48b69e)

🚀 CI¶

gitlab-ci: prevent 'sonarcloud' job launch upon 'gcil' local use (8ba9700)
gitlab-ci: run SonarCloud analysis on merge request pipelines (0f34e2d)
gitlab-ci: watch for 'config/*' changes in 'serve' job (c47e433)
gitlab-ci: fetch Git tags history in 'pages' job execution (c4c8b71)
gitlab-ci: fetch with '--unshallow' for full history in 'pages' (cd6d65e)

📦 Build¶

containers: use 'apk add --no-cache' for lighter images (d13b26a)
pages: add 'git-cliff' to the ':pages' image (26f26c6)

3.0.0 (2024-08-25)¶

✨ Features¶

cli: implement '--config FOLDER' and '--default' configurations (081fd94)
cli: implement '--clean' to run 'pre-commit clean' cache cleanups (b971337)
entrypoint: configure unused hooks upon '--default' use (a271c43)
entrypoint: inject badge in 'README.md' upon '--configure' (739774d)
entrypoint: add 'README.md' to '--configure' commmands hint (8d7ddcc)
entrypoint: migrate to commitizen '3.29.0+adriandc.20240825' (9c6f378)
entrypoint: allow newer commitizen versions usage (138ef35)
entrypoint, features: refactor into static features classes (9b85378)
🚨 BREAKING CHANGE 🚨 | main: avoid running '--run' features upon '--enable' (1c9134d)
prepare_commit_message: inject signoff if commitizen 'always_signoff' (f402004)
updates: migrate from deprecated 'pkg_resources' to 'packaging' (1205341)

🐛 Bug Fixes¶

entrypoint: resolve unused hooks issues with '--default' (9dc8309)
entrypoint: remove 'README.md' debugging log in '--configure' (71ceb42)
precommit: resolve '--default' use with existing configuration (7543149)
templates: migrate to 'run-gcil-*' skipped hooks names (63df3c3)

📚 Documentation¶

readme: add badge compatibility and syntax documentation (9de0ad9)
readme: add 'mkdocs' and 'mkdocs-material' references (f9eac20)
requirements: install 'types-PyYAML>=6.0.12.2' as quality dependency (4d09100)

⚙️ Cleanups¶

commitizen: migrate to new 'filter' syntax (commitizen#1207) (4342bea)
entrypoint: constantify '{PACKAGE_REVISION}' template string (8a77371)
pre-commit: add 'python-check-blanket-type-ignore' and 'python-no-eval' (31738fe)
pre-commit: simplify and unify 'local-gcil' hooks syntax (001b11d)
pre-commit: add 'additional_dependencies' for missing YAML (9c80622)
pre-commit: improve syntax for 'args' arguments (0d7e947)
pre-commit: migrate to 'run-gcil-*' template 'gcil' hooks (8e0f5cf)
pre-commit: update against 'run-gcil-push' hook template (cb69d0b)
pre-commit: add missing 'commit-msg' stage for commitizen (a27b9dd)

📦 Build¶

requirements: add 'PyYAML>=6.0' as runtime dependency (2fe8d58)

2.1.0 (2024-08-24)¶

✨ Features¶

entrypoint: use 'pre-commit install --allow-missing-config' (d41b2f3)
entrypoint: use 'pre-commit run --all-files' parameter syntax (956cb33)
pre-commit: exclude '.patch' Git patch files from hooks (e865955)
pre-commit: disable 'detect-private-key' by default (5ef6060)
pre-commit-config: exclude 'eicar.*' Anti Malware Testfile (6dbdb7c)

🐛 Bug Fixes¶

pre-commit: fix 'destroyed-symlinks' v4.6.0 missing stages (5377b8f)
templates/commits: avoid failing without 'local-gcil-*' hooks (1d9dc15)

📚 Documentation¶

components: add GitLab CI/CD Catalog for components URL (47068c6)
hooks: fix hooks 'repo:' URL for '.pre-commit-config.yaml' (b7c059e)
hooks: improve hook '.pre-commit-config.yaml' documentation (7a3c283)
prepare: fix 'Commit type' list faulty indentation issue (42f49cb)

⚙️ Cleanups¶

pre-commit: fail 'gcil' jobs if 'PRE_COMMIT' is defined (1fcb35c)

🚀 CI¶

gitlab-ci: improve 'serve' job syntax for YAML rendering (aa41a7e)
gitlab-ci: cleanup cache upon 'serve' job end (4574326)
gitlab-ci: ignore 'serve' job failure due to 'Ctrl+C' end (c8718b5)
gitlab-ci: avoid failures of 'codestyle' upon local launches (6660428)

2.0.2 (2024-08-22)¶

📚 Documentation¶

components, hooks: add file name headers for sources changes (77cfb9b)
prepare: bind 'preview.svg' image as a webpage asset (2e214bd)
preview: add 'clear' calls before 'git add' sections (8dd763c)
preview: fix SVG preview for version 2.0.1 (1d34359)
readme: remove '{ ... }' wrappers for single commands (dd892d8)
readme: simplify and cleanup commands documentation (d2d3b38)

🚀 CI¶

gitlab-ci: create 'hooks' local job for maintenance (df35dc9)
gitlab-ci: prepare and remove '.cache' even upon failures (f56f38e)
gitlab-ci: use 'origin/develop' as hooks revision for 'preview' (9c0c29c)

2.0.1 (2024-08-21)¶

✨ Features¶

commitizen: refactor commits documentation and improve markdown (10d1da9)

📚 Documentation¶

docs: add 'commitizen' to the project main description (effba2f)
docs: embed files directly using 'mkdocs' syntax '--8<-- "..."' (a51755e)
docs: improve headers with links for configurations files (565c92f)
preview: refresh SVG preview for version 2.0.1 (50621dc)
readme: add 'Package' link in the 'README' documentation (6238b85)

🚀 CI¶

gitlab-ci: watch for '.cz.yaml' in 'serve' job (e1f8319)

2.0.0 (2024-08-21)¶

✨ Features¶

cli: refactor 'manage' tool into 'pre-commit-crocodile' entrypoint (fcd6a33)
cli: run requested mode only and not related modes too (4aef5dd)
cli: implement '--list' mode to list installed hooks (72bc197)
configurations: add 'mkdocs' detection and isolate 'docs/' (3d8f988)
configurations: refactor 'docs/' and 'test[s]?/' into evaluators (f0e880c)
configurations: catch 'recipes-*/(...)' Yocto recipe as fallback (ee8d4c2)
configurations: evaluate 'containers/' changes for commits (1078898)
configurations: add evaluator for 'templates/' as 'ci' commit (e818b59)
entrypoint: configure '.pre-commit-config.yaml' with revision (db6f0f8)
entrypoint: list detected Git remote upon 'git remote set-head' (4b91a48)
entrypoint: add commit instructions for '--configure' mode (750d69b)
entrypoint: automatically resolve 'check-hooks-apply' errors (69852d1)
hooks: comment 'Issue: #...' template by default (bdf466f)
main: set '--configure' as 'Edit sources with hooks configurations' (ff16952)
main: avoid '--autoupdate' features upon '--enable' mode (c715b6a)
main: enable '--enable' features upon '--autoupdate' mode (2e5464b)
mkdocs, gitlab-ci: implement GitLab Pages with 'mkdocs' (76b963a)
package: add 'DEBUG_REVISION_SHA' to force package revision (372c7c0)
🚨 BREAKING CHANGE 🚨 | setup: drop support for Python 3.8 due to 'importlib.resources' (0e2772f)
src: import package, prints, system and types from 'gcil' (f30ec12)
version: create 'Version.revision' API to get tag or SHA1 revision (6d28e45)

🐛 Bug Fixes¶

cli, assets: implement '--configure' to deploy configurations (e64a0a8)
configurations: detect 'requirements/' changes for commit messages (06d0243)
configurations: make folder and file name regexes non-greedy (356001f)
entrypoint: uninstall Python packages only if installed first (ed6291f)
entrypoint: use 'HEAD~1' instead of 'HEAD^' for Windows compatibility (fe44ab8)
entrypoint: update Git remote upon '--enable' instead of '--autoupdate' (e3f9ead)
entrypoint: pre-stage '.pre-commit-config.yaml' for hooks checks (a3bcfc9)
entrypoint: resolve Python 3.8 support of f-string with quotes (6f127a7)
entrypoint: fix Python <3.11 without 'importlib.resources.abc' (0708445)
hooks: use '\n' as commit message lines separator (8abf039)
main: align help position limit to 23 chars (db766b8)
main: merge and refactor modes validation (python:S108) (5f76347)
platform: always flush on Windows hosts without stdout TTY (3848f85)
pre-commit-config: enable all 'pre-commit-hooks' hooks by default (c487bf8)

🚜 Code Refactoring¶

hooks: isolate all hooks sources under 'src/hooks/' (49beecf)

📚 Documentation¶

components: document GitLab CI/CD component for 'commits' (db8565d)
docs: refactor and create new specification pages (15b43ff)
docs: remove 'Documentation:' link from 'README.md' sources (b269976)
mkdocs: migrate to 'mkdocs-material' theme and features (d7079d6)
mkdocs: add 'commitizen' and 'pre-commit' reference pages (864af2a)
prepare: fixup [optional !]: quotings for 'commits` (612f2a1)
preview: implement 'preview' SVG documentation (86831d5)
preview: implement commits creation documentation (3b2709e)
preview: refresh SVG preview for 'check-hooks-apply' fixes (9710474)
readme: improve 'prepare-commit-message' documentation (f7cdcd4)
readme: document 'pre-commit' and 'commitizen' installations (9ec1970)
readme: document '--settings' and 'NO_COLOR' configurations (30931f6)
readme: add new dependencies and references links (9949b22)
readme: improve 'Features' and 'Commands' documentations (2b52013)
readme: fix 'pre-commit-crocodile --autoupdate' documentation (b392403)
readme: refactor and use 'pre-commit' badges for 'Commands' (03b3b7c)
readme: add 'pre-commit-crocodile' documentation badges (812d22b)
readme: add SonarCloud analysis project badges (0a55099)
readme: link 'gcil' back to 'gitlabci-local' PyPI package (5f90c33)
readme: isolate '--autoupdate' from '--enable' instructions (2f87610)
readme: clarify commands for projects with/without configurations (5be9579)
readme, docs: add 'pre-commit enabled' badges (df4de33)
settings: remove 'engines' configuration derived from 'gcil' (136173f)

🧪 Test¶

requirements: raise 'pexpect-executor' version to 4.0.0 (240a9e2)
requirements: raise 'pexpect-executor' version to 4.0.1 (66fad86)

⚙️ Cleanups¶

cliff: fix 'pre-commit-crocodile' GitLab URL in CHANGELOG (b92eaca)
entrypoint: refactor assets resources access (aaa104f)
entrypoint: reorder 'options.disable' code section (cdd8dad)
entrypoint: minor 'Commands' codestyle improvements (4751c20)
gitattributes: always checkout Shell scripts with '\n' EOL (6ff1836)
gitignore: ignore '.*.swp' intermediates 'nano' files (b63d959)
gitignore: ignore '.tmp.*' intermediate files (c11c992)
gitignore: minor comment improvement for 'Documentation' (cb96c3c)
pre-commit: rename repository to 'pre-commit-crocodile' (8e92229)
pre-commit: run 'codestyle', 'lint' and 'typings' jobs (6556920)
pre-commit: fix '.py' local Python hook execution (27d8d2e)
setup: add requirements from 'runtime.txt' as dependencies (73ed96f)
setup: add 'Statistics' URL to the package description (33a92e5)
vscode: ignore '.tmp.entrypoint.*' files in VSCode (39e9170)

🚀 CI¶

commits: use 'pre-commit-crocodile:commits' image (f3fefc2)
commits: implement 'commits' job as a GitLab component (510f44c)
gitlab-ci: show fetched merge request branches in 'commits' (b109199)
gitlab-ci: need preparation jobs for 'pages' deployment job (4f68937)
gitlab-ci: always run 'commits' job on merge request pipelines (3c54504)
gitlab-ci: fix 'image' of 'commits' job (9a7614b)
gitlab-ci: fix 'before_script' of 'commits' job and add comments (cc7492a)
gitlab-ci: validate 'pre-commit' checks in 'commits' job (ac2291d)
gitlab-ci: rehost 'python:3.12' with 'images' job for 'pages' (bca847a)
gitlab-ci: prepare 'build' and 'deploy' container images (355c3fb)
gitlab-ci: implement 'build' job to build and package '.whl' (dc2558d)
gitlab-ci: import 'install' job from 'gcil' (5c3327b)
gitlab-ci: import 'readme' job from 'gcil' (2b0ec11)
gitlab-ci: isolate documentation preparation into 'docs/prepare.sh' (5ad76f5)
gitlab-ci: create 'serve' local jobs for 'mkdocs' tests (017e0cf)
gitlab-ci: use 'HEAD~1' instead of 'HEAD^' for Windows compatibility (e2978b8)
gitlab-ci: patch '.pre-commit-config.yaml' asset version upon tag (482c221)
gitlab-ci: use 'pre-commit-crocodile:build' image (bb1e245)
gitlab-ci: check only Python files in 'typings' job (b511437)
gitlab-ci: use 'DEBUG_REVISION_SHA' for unreleased 'preview' use (ab92cde)
gitlab-ci: implement SonarCloud quality analysis (2b16fe9)
gitlab-ci: implement 'deploy:*' release jobs from 'gcil' (3d9ddff)
gitlab-ci: deploy 'pages' on 'main' branch only (1c61717)
gitlab-ci: run 'pages' jobs after successful tests and coverage (ab223cc)
gitlab-ci: detect and refuse '^wip|^WIP' commits (85291d1)
gitlab-ci: isolate 'commits' job to 'templates/commit.yml' (7305d70)
gitlab-ci: watch 'docs/' changes for 'prepare.sh' in 'serve' job (cbb3b33)
gitlab-ci, containers: create 'pre-commit-crocodile:pages' image (44470bc)
gitlab-ci, containers: create 'pre-commit-crocodile:codestyle' image (987ec50)
gitlab-ci, containers: create 'pre-commit-crocodile:preview' image (215e1d3)
gitlab-ci, tests: implement coverage initial jobs and tests (5169994)

📦 Build¶

codestyle: install 'pexpect-executor' in the ':codestyle' image (7faf133)
commits: create 'pre-commit-crocodile:commits' simple image (48fcf9e)
preview: install 'git' in the ':preview' image (e03e6d0)
preview: install 'nano' in the ':preview' image (ae44cc0)
requirements: install 'pexpect-executor' in ':preview' image (5587450)
requirements: install 'pipx' in the ':preview' image (250a536)

1.1.0 (2024-08-17)¶

✨ Features¶

pre-commit-crocodile: migrate to 'pre-commit-crocodile' name (cd8bad7)

🚜 Code Refactoring¶

src: isolate all sources under 'src/' (894a161)

📚 Documentation¶

readme: update project descriptions for developers (cf33578)
readme: add 'Conventional Commits' URL as reference link (d984931)
readme: document features and usage of 'prepare-commit-message' (985524e)

🚀 CI¶

gitlab-ci: remove unused 'requirements' folder changes checks (f1b5f64)

1.0.1 (2024-08-17)¶

📚 Documentation¶

cliff: import 'git-cliff' configurations from 'gcil' (584fea2)

1.0.0 (2024-08-17)¶

✨ Features¶

pre-commit: bind 'prepare-commit-message' CLI entrypoint (38257d2)
pre-commit-hooks: migrate to '.pre-commit-hooks.yaml' hook (75ca0c1)
prepare-commit-msg-template: evaluate 'pre_commit_hooks' path (cce56ea)
setup: implement initial 'setup.py' packaging from 'gcil' (337322a)

📚 Documentation¶

license: apply Apache License 2.0 license to the project (5796350)
readme: initial 'README.md' documentation with dependencies (9108c38)
readme: document RadianDevCore 'pre-commit-hooks' repository (2b75e41)
readme: document 'prepare-commit-message' as available hook (27ae472)

🎨 Styling¶

commitizen, pre-commit: implement 'commitizen' configurations (ad3713b)
markdownlint: import Markdown codestyle rules from 'gcil' (2d2c43e)
mypy: import Python Mypy linting rules from 'gcil' (1fc611a)
pre-commit: implement initial 'pre-commit' configurations (cd9d252)
pre-commit: enable 'check-hooks-apply' and 'check-useless-excludes' (0a61f1b)
yapf: import Python YAPF codestyle rules from 'gcil' (51983c4)

⚙️ Cleanups¶

gitignore: ignore Python compiled intermediates (853f1ca)
gitignore: ignore '.tmp' folder intermediates (3737d2f)
hooks: implement evaluators and matchers priority parser (4975ec1)
pre-commit: fix 'commitizen-branch' for same commits ranges (81ae190)
pre-commit: disable 'check-xml' and 'check-toml' unused hooks (ecc2a18)
vscode: import Visual Studio configurations from 'gcil' (8ea708e)

🚀 CI¶

gitlab-ci: import 'changelog' and quality jobs from 'gcil' (9ce445e)

📦 Build¶

hooks: implement 'prepare-commit-msg' template generator (60221d8)
hooks: create './.hooks/manage' hooks manager for developers (d731261)