Changelog¶

Development (2025-02-02)¶

📚 Documentation¶

docs: use '<span class=page-break>' instead of '<div>' (da31616)
prepare: avoid 'TOC' injection if 'hide: - toc' is used (02a4585)

🎨 Styling¶

colors: ignore 'Colored' import 'Incompatible import' warning (dd6f537)

⚙️ Cleanups¶

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

🚀 CI¶

gitlab-ci: run coverage jobs if 'sonar-project.properties' changes (f6b0152)
gitlab-ci: watch for 'docs/.*' changes in 'pages' jobs (ec054fe)

3.2.0 (2025-01-01)¶

✨ Features¶

cli: implement '--get-milestone' feature (90e04d6)
cli: implement '--set-milestone-...' features (8cc195a)
cli: implement '--create-milestone' feature (3bbd521)
entrypoint, milestones: avoid milestone updates without changes (6665602)

🐛 Bug Fixes¶

cli: use package name for 'Updates' checks (7c34da0)
entrypoint: validate GitLab issues feature and missing milestone (f695006)
main: resolve '--milestones-statistics' usage without milestone (f5eaae0)

📚 Documentation¶

mkdocs: minor '(prefers-color-scheme...)' syntax improvements (7713a73)
mkdocs: remove 'preview.py' and 'template.svg' files exclusions (064efff)
mkdocs, pages: use 'MKDOCS_EXPORTER_PDF_OUTPUT' for PDF file (f13bf5e)
pages: rename PDF link title to 'Export as PDF' (ecbfdd0)
pdf: avoid header / footer lines on front / back pages (e0dae64)
pdf: minor stylesheets codestyle improvements (37b163a)
pdf: reverse PDF front / back cover pages colors for printers (b6e008e)
prepare: use 'mkdocs.yml' to get project name value (f4c487c)
stylesheets: resolve lines and arrows visibility in dark mode (6a21bb4)
templates: add 'Author' and 'Description' to PDF front page (c38f8d4)
templates: add 'Date' detail on PDF front page (36f0ad8)
templates: use Git commit SHA1 as version if no Git tag found (c46b5b1)
webhooks: document milestones update triggers with tokens (60a6db9)

🧪 Test¶

test: fix daily updates coverage test syntax (8a68157)

🚀 CI¶

gitlab-ci: avoid PDF slow generation locally outside 'pdf' job (e9cbb16)
gitlab-ci: validate host network interfaces support (0c09b87)
gitlab-ci: enable '.local: no_regex' feature (f7e8684)
gitlab-ci: append Git version to PDF output file name (7adf216)
gitlab-ci: rename PDF to 'gitlab-projects-issues' (bbf0e66)
gitlab-ci: migrate to 'pre-commit-crocodile/commits@4.0.0' (aa7956f)
gitlab-ci: ensure 'pages' job does not block pipeline if manual (d826d86)
gitlab-ci: change release title to include tag version (7e1b4d8)

3.1.0 (2024-10-28)¶

🐛 Bug Fixes¶

main: ensure 'FORCE_COLOR=0' if using '--no-color' flag (6fbbb9b)
milestones: resolve milestones sort if due dates are empty (c360429)

📚 Documentation¶

assets: prepare mkdocs to generate mermaid diagrams (74aa2ef)
cliff: improve 'Unreleased' and refactor to 'Development' (d607c57)
covers: resolve broken page header / footer titles (d0fed68)
custom: change to custom header darker blue header bar (e990562)
docs: improve documentation PDF outputs with page breaks (4f8c595)
mkdocs: enable 'git-revision-date-localized' plugin (79ebaed)
mkdocs: change web pages themes colors to 'blue' (289d9a0)
mkdocs: fix 'git-revision-date-localized' syntax (8434fb4)
mkdocs: migrate to 'awesome-pages' pages navigation (e8bfbf4)
mkdocs: change 'auto / light / dark' themes toggle icons (cfb8faa)
mkdocs: enable and configure 'minify' plugin (fff8e09)
mkdocs: install 'mkdocs-macros-plugin' for Jinja2 templates (6ce1d39)
mkdocs: enable 'pymdownx.emoji' extension for Markdown (e6c5159)
mkdocs: implement 'mkdocs-exporter' and customize PDF style (4f9a045)
mkdocs: set documentation pages logo to 'solid/code' ('</>') (ad7e659)
mkdocs: enable 'permalink' headers anchors for table of contents (314e71d)
mkdocs: prepare 'privacy' and 'offline' plugins for future usage (4f0c78e)
mkdocs: disable Google fonts to comply with GDPR data privacy (df5f19e)
mkdocs: implement 'Table of contents' injection for PDF results (9417c29)
mkdocs: enable 'Created' date feature for pages footer (4e07e50)
mkdocs: add website favicon image and configuration (5eb522d)
mkdocs: implement 'book' covers to have 'limits' + 'fronts' (0bef12b)
mkdocs: isolate assets to 'docs/assets/' subfolder (a4afa3f)
mkdocs: exclude '.git' from watched documentation sources (b5b4f5b)
mkdocs, prepare: resolve Markdown support in hidden '<details>' (ec82132)
pages: rename index page title to '‣ Usage' (53cf129)
pdf: simplify PDF pages copyright footer (e5a69c6)
pdf: migrate to custom state pseudo class 'state(...)' (d030542)
prepare: regenerate development 'CHANGELOG' with 'git-cliff' (f1088bc)
prepare: avoid 'md_in_html' changes to 'changelog' and 'license' (b8196ec)
prepare: fix '<' and '>' changelog handlings and files list (dc404af)
prepare: implement 'About / Quality' badges page (b34c974)
prepare: improve 'Quality' project badges to GitLab (aa17b59)
prepare: use 'docs' sources rather than '.cache' duplicates (1c6ce3b)
prepare: resolve 'docs/about' intermediates cleanup (e7b86dc)
prepare: add PyPI badges and license badge to 'quality' page (4ecf27c)
prepare: avoid adding TOC to generated and 'no-toc' files (dba60cf)
readme: add 'gcil:enabled' documentation badge (cb3a0c7)
readme: add pypi, python versions, downloads and license badges (bda3079)
readme: add '~/.python-gitlab.cfg' section title (66b470e)
readme: minor improvements to milestone statistics example (a94a34a)
robots: configure 'robots.txt' for pages robots exploration (e151f17)

⚙️ Cleanups¶

gitignore: exclude only 'build' folder from sources root (224a9db)
gitignore: exclude '/build' folder or symlink too (c82ae90)
sonar: wait for SonarCloud Quality Gate status (6b53619)
vscode: use 'yzhang.markdown-all-in-one' for Markdown formatter (f353e9e)

🚀 CI¶

gitlab-ci: prevent 'sonarcloud' job launch upon 'gcil' local use (df62caf)
gitlab-ci: run SonarCloud analysis on merge request pipelines (607974e)
gitlab-ci: watch for 'config/*' changes in 'serve' job (432dbe4)
gitlab-ci: fetch Git tags history in 'pages' job execution (0f62ead)
gitlab-ci: fetch with '--unshallow' for full history in 'pages' (45e36af)
gitlab-ci: enforce 'requirements/pages.txt' in 'serve' job (95758e9)
gitlab-ci: add 'python:3.12-slim' image mirror (08f0ccb)
gitlab-ci: inject only 'mkdocs-*' packages in 'serve' job (a3dbec8)
gitlab-ci: install 'playwright' with chromium in 'serve' job (17b8af9)
gitlab-ci: find files only for 'entr' in 'serve' (6762249)
gitlab-ci: improve GitLab CI job outputs for readability (67e8499)
gitlab-ci: deploy GitLab Pages on 'CI_DEFAULT_BRANCH' branch (0a9ab9d)
gitlab-ci: ignore 'variables.scss' in 'serve' watcher (824951d)
gitlab-ci: preserve only existing Docker images after 'images' (87aaf96)
gitlab-ci: use 'MKDOCS_EXPORTER_PDF_ENABLED' to disable PDF exports (836dd8f)
gitlab-ci: run 'pages' job on GitLab CI tags pipelines (2f8e072)
gitlab-ci: isolate 'pages: rules: changes' for reuse (488a182)
gitlab-ci: allow manual launch of 'pages' on protected branches (684ae40)
gitlab-ci: create 'pdf' job to export PDF on tags and branches (971b815)
gitlab-ci: implement local pages serve in 'pages' job (ee3097b)
gitlab-ci: raise minimal 'gcil' version to '11.0' (31fae81)
gitlab-ci: enable local host network on 'pages' job (d06f4a4)
gitlab-ci: detect failures from 'mkdocs serve' executions (9413853)
gitlab-ci: refactor images containers into 'registry:*' jobs (24fad8a)
gitlab-ci: bind 'registry:' dependencies to 'requirements/.txt' (d1ac987)

📦 Build¶

build: import missing 'build' container sources (d599a9b)
containers: use 'apk add --no-cache' for lighter images (721bdf2)
pages: add 'git-cliff' to the ':pages' image (e4515a4)
pages: migrate to 'python:3.12-slim' Ubuntu base image (73cfa3a)
pages: install 'playwright' dependencies for 'mkdocs-exporter' (b04b34d)
pages: install 'entr' in the image (23f4f0e)
requirements: install 'mkdocs-git-revision-date-localized-plugin' (82f1f51)
requirements: install 'mkdocs-awesome-pages-plugin' plugin (5cbde0f)
requirements: install 'mkdocs-minify-plugin' for ':pages' (1d38343)
requirements: install 'mkdocs-exporter' in ':pages' (dae9328)
requirements: migrate to 'mkdocs-exporter' with PR#35 (de610a3)
requirements: upgrade to 'playwright' 1.48.0 (c542f4b)
requirements: migrate to 'mkdocs-exporter' with PR#42/PR#41 (42919a5)

3.0.2 (2024-08-25)¶

✨ Features¶

updates: migrate from deprecated 'pkg_resources' to 'packaging' (41b9b29)

📚 Documentation¶

mkdocs: implement GitLab Pages initial documentation and jobs (ff84cb2)
readme: link against 'gcil' documentation pages (cf35987)

⚙️ Cleanups¶

commitizen: migrate to new 'filter' syntax (commitizen#1207) (0461494)
pre-commit: add 'python-check-blanket-type-ignore' and 'python-no-eval' (d96a990)
pre-commit: fail 'gcil' jobs if 'PRE_COMMIT' is defined (972ecf0)
pre-commit: simplify and unify 'local-gcil' hooks syntax (4742542)
pre-commit: improve syntax for 'args' arguments (4fa55b2)
pre-commit: migrate to 'run-gcil-*' template 'gcil' hooks (e95b0c7)
pre-commit: update against 'run-gcil-push' hook template (a05195d)
pre-commit: migrate to 'pre-commit-crocodile' 3.0.0 (988835b)

🚀 CI¶

containers: implement ':pages' image with 'mkdocs-material' (ceafc32)
gitlab-ci: avoid failures of 'codestyle' upon local launches (a37b540)
gitlab-ci: migrate to 'pre-commit-crocodile/commits@2.1.0' component (011e795)
gitlab-ci: migrate to 'pre-commit-crocodile/commits@3.0.0' component (0311b02)

3.0.1 (2024-08-21)¶

🚀 CI¶

gitlab-ci: fix 'deploy:container' release job (103f564)

3.0.0 (2024-08-21)¶

✨ Features¶

🚨 BREAKING CHANGE 🚨 | setup: drop support for Python 3.6 (48b40fd)
🚨 BREAKING CHANGE 🚨 | setup: drop support for Python 3.7 (ae1ed7a)

🐛 Bug Fixes¶

package: fix package name for 'importlib' version detection (a95fd74)
platform: always flush on Windows hosts without stdout TTY (0c2df39)
statistics: resolve floating point equalities (python:S1244) (6c6e4c2)

📚 Documentation¶

readme: add 'pre-commit enabled' badges (3fff570)
readme: add SonarCloud analysis project badges (ebc6038)
readme: link 'gcil' back to 'gitlabci-local' PyPI package (2f3c8e3)

⚙️ Cleanups¶

commitizen: migrate to 'pre-commit-crocodile' 2.0.1 (5da2ff0)
gitattributes: always checkout Shell scripts with '\n' EOL (dce2373)
gitignore: ignore '.*.swp' intermediates 'nano' files (75a727a)
hooks: implement evaluators and matchers priority parser (851bfa1)
pre-commit: run 'codestyle', 'lint' and 'typings' jobs (49aa37e)
pre-commit: migrate to 'pre-commit-crocodile' 2.0.0 (773236c)

🚀 CI¶

gitlab-ci: show fetched merge request branches in 'commits' (6fa4f87)
gitlab-ci: fix 'image' of 'commits' job (4b3ce16)
gitlab-ci: always run 'commits' job on merge request pipelines (0bd22cc)
gitlab-ci: make 'needs' jobs for 'build' optional (1bed1f6)
gitlab-ci: validate 'pre-commit' checks in 'commits' job (8506e8d)
gitlab-ci: refactor images into 'containers/*/Dockerfile' (8788e71)
gitlab-ci: use 'HEAD~1' instead of 'HEAD^' for Windows compatibility (e613bb1)
gitlab-ci: check only Python files in 'typings' job (787e84c)
gitlab-ci: implement SonarCloud quality analysis (90dbb69)
gitlab-ci: detect and refuse '^wip|^WIP' commits (b2a8071)
gitlab-ci: isolate 'commits' job to 'templates/commit.yml' (eb8431b)
gitlab-ci: migrate to 'pre-commit-crocodile/commits@2.0.0' component (8f92b7c)
gitlab-ci: create 'hooks' local job for maintenance (dd429da)
gitlab-ci, tests: implement coverage initial jobs and tests (d72e5ce)

📦 Build¶

pre-commit: migrate to 'pre-commit-crocodile' 1.1.0 (ef26db9)

2.2.0 (2024-08-15)¶

🐛 Bug Fixes¶

setup: refactor 'python_requires' versions syntax (7ee6dc2)
setup: resolve project package and name usage (0afa3a7)
updates: ensure 'DEBUG_UPDATES_DISABLE' has non-empty value (18d921b)
updates: fix offline mode and SemVer versions comparisons (a67c8b7)

📚 Documentation¶

cliff: use '|' to separate breaking changes in 'CHANGELOG' (af857b2)
license: update copyright details for 2024 (3eca176)
readme: add 'Commitizen friendly' badge (b96b30a)

🎨 Styling¶

cli: improve Python arguments codestyle syntax (ce9cac6)
commitizen, pre-commit: implement 'commitizen' custom configurations (9488db6)
pre-commit: implement 'pre-commit' configurations (34534f1)

⚙️ Cleanups¶

cli, package: minor Python codestyle improvements (02ea0ae)
pre-commit: disable 'check-xml' unused hook (4e7e544)
pre-commit: fix 'commitizen-branch' for same commits ranges (ca6817f)
setup: refactor with more project configurations (f07ae78)
updates: ignore coverage of online updates message (c408cdd)
vscode: remove illegal comments in 'extensions.json' (7a37d41)

🚀 CI¶

gitlab-ci: watch for 'codestyle', 'lint' and 'typings' jobs success (b0504e5)
gitlab-ci: create 'commits' job to validate with 'commitizen' (51d41d5)
gitlab-ci: fix 'commits' job for non-default branches pipelines (b60089f)

📦 Build¶

hooks: create './.hooks/manage' hooks manager for developers (237612c)
hooks: implement 'prepare-commit-msg' template generator (dc436aa)
pre-commit: enable 'check-hooks-apply' and 'check-useless-excludes' (4b361d5)

2.1.0 (2024-08-11)¶

✨ Features¶

cli: implement '--no-color' to disable colors (e3c3376)

🐛 Bug Fixes¶

package: check empty 'environ' values before usage (a9b8937)
updates: remove unused 'recommended' feature (7b3a4c4)

📚 Documentation¶

readme: migrate from 'gitlabci-local' to 'gcil' package (326712f)

⚙️ Cleanups¶

colors: resolve 'pragma: no cover' detection (6559e13)
platform: disable coverage of 'SUDO' without write access (09c2042)
setup: remove faulty '# pragma: exclude file' flag (f6a4310)

2.0.2 (2024-08-10)¶

✨ Features¶

setup: add support for Python 3.12 (ad3d5f6)

🧪 Test¶

setup: disable sources coverage of the build script (4653fa4)

🚀 CI¶

gitlab-ci: raise latest Python test images from 3.11 to 3.12 (60f3c29)
gitlab-ci: deprecate outdated and unsafe 'unify' tool (e820b67)

2.0.1 (2024-08-10)¶

✨ Features¶

gitlab-projects-issues: migrate under 'RadianDevCore/tools' group (55516fa)

🐛 Bug Fixes¶

settings: ensure 'Settings' class initializes settings file (b8afd5b)
src: use relative module paths in 'init' and 'main' (965c996)

2.0.0 (2024-08-08)¶

🛡️ Security¶

🚨 BREAKING CHANGE 🚨 | cli: acquire tokens only from environment variables (ca80cfe)

✨ Features¶

🚨 BREAKING CHANGE 🚨 | cli: refactor CLI into simpler GitLab URL bound parameters (f589c8d)
cli: add tool identifier header with name and version (ffb86e6)
cli: implement '.python-gitlab.cfg' GitLab configurations files (e87a3c7)
cli, argparse: implement environment variables helpers (74acb0e)
cli, gitlab: implement CI job token and public authentications (57b7253)
main: document '--default-estimate' metavar as 'ESTIMATE' (d5a46d8)

🐛 Bug Fixes¶

environments: add missing ':' to the README help description (7e05429)

📚 Documentation¶

cliff: document 'security(...)' first in changelog (e0e2b46)
readme: document '~/.python-gitlab.cfg' configuration file (d9b5954)

⚙️ Cleanups¶

cli/main: minor codestyle improvement of 'import argparse' (33e608b)
types: cleanup inconsistent '()' over base classes (a0eaa89)

🚀 CI¶

gitlab-ci: migrate from 'git-chglog' to 'git-cliff' (79b29f0)
gitlab-ci: bind '.docker/config.json' for local test builds (5ac41d5)

1.0.5 (2024-07-14)¶

🐛 Bug Fixes¶

entrypoint: initialize for issues without assignee and milestone (f3692b8)

1.0.4 (2024-07-14)¶

🐛 Bug Fixes¶

entrypoint: avoid failures upon issues without milestones (57c8dc6)

1.0.3 (2024-06-10)¶

📚 Documentation¶

readme: improve milestones statistics outputs example (decf7f4)

🚀 CI¶

gitlab-ci: install 'coreutils' in the deployed container image (4946bdb)
gitlab-ci: use 'buildah' instead of 'docker' to pull images (0b969b9)

1.0.2 (2024-06-01)¶

🚀 CI¶

gitlab-ci: set '/bin/sh' as 'CMD' rather than 'ENTRYPOINT' (5e742d8)

1.0.1 (2024-06-01)¶

📚 Documentation¶

chglog: add 'ci' as 'CI' configuration for 'CHANGELOG.md' (29f0b43)
readme: update 'README.md' for 'gitlab-projects-issues' (4fb7d02)

🚀 CI¶

gitlab-ci: change commit messages to tag name (8f8016f)

1.0.0 (2024-06-01)¶

✨ Features¶

gitlab-projects-issues: initial sources implementation (f1cc034)

🚀 CI¶

gitlab-ci: use 'CI_DEFAULT_BRANCH' to access 'develop' branch (bae1c08)
gitlab-ci: rehost 'docker:latest' image in 'images' job (c4cfc9a)
gitlab-ci: rehost 'quay.io/buildah/stable:latest' image (100c069)
gitlab-ci: implement 'deploy:container' release container image (d3eae88)