From 1346fea3138efaee3cd18e46e0916cad38fb418c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pl=C3=ADchal?= Date: Tue, 14 Jul 2026 10:21:00 +0200 Subject: [PATCH 1/2] Add release notes for did-0.21, 0.22, 0.23 and 0.24 Create a new docs/releases.rst page covering the last three releases and the upcoming 0.24. Add the page to the docs table of contents. Co-Authored-By: Claude Opus 4.6 --- docs/index.rst | 1 + docs/releases.rst | 115 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 116 insertions(+) create mode 100644 docs/releases.rst diff --git a/docs/index.rst b/docs/index.rst index 853b3787..f50257ae 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ Table of Contents Overview Install + Releases Config Examples Plugins diff --git a/docs/releases.rst b/docs/releases.rst new file mode 100644 index 00000000..f6a062f3 --- /dev/null +++ b/docs/releases.rst @@ -0,0 +1,115 @@ +.. _releases: + +====================== + Releases +====================== + + +did-0.24 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The first day of the week is now **configurable** via the +``week_start`` option in the ``[general]`` config section. This +is useful for teams and regions where the week starts on Sunday +or another day. Flexible matching is supported — full names or +three-letter abbreviations like ``sun`` or ``mon`` work. + +The ``--width 0`` option can be used to produce reports with +unlimited line width. + +Tokens can now be fetched from an **external command** using the +new ``token_command`` config option, enabling integration with +password managers such as 1Password or BitWarden. The option is +supported by all plugins that use token authentication. + + +did-0.23 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Initial support for the Forgejo_ backend has been added with +stats for **created issues** and **created pull requests**. + +Both GitHub and GitLab plugins now track pull/merge requests +**authored by you and successfully merged**, a new stat alongside +the existing created and commented ones. + +Jira Cloud is now a first-class citizen with dedicated +authentication and query handling, and Jira issues **with +worklogs** can be collected as well. + +A new ``--full-message`` flag lets you include the complete body of +commits, pull requests and merge requests in the report instead of +just the summary line. + +The GitLab plugin no longer fetches thousands of pages when the API +returns a large result set, and the default 60-second timeout has +been fixed. GitHub error responses are now handled gracefully, and +the ``commented_in_range`` filter works correctly. + +Parsing of the ``--config`` argument with whitespace has been +fixed. + +Significant **typing and test coverage** improvements across the +codebase: type hints have been added to ``base.py``, ``cli.py``, +``conftest.py``, and the Jira, Confluence, Bugzilla, Bodhi and +items plugins. New unit test suites cover the ``utils`` and +``stats`` modules. Python 3.14 is now supported. + +.. _Forgejo: https://forgejo.org/ + + +did-0.22 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``did last monday`` through ``did last sunday`` syntax now +works for quickly selecting a single past day by name. + +Stats collection now runs **in parallel** using a thread pool, +which noticeably speeds up reports that query many backends. The +report is completed even when individual plugins encounter errors. + +The GitHub plugin gains support for filtering by ``user``, +``org`` and ``repo``, an ``exclude_org`` option, and properly +collects comments. + +The Jira plugin received substantial improvements in this release. +A new ``transition`` stat tracks issues that moved between states. +Updated issues and issues resolved by a tester or contributor can +now be collected, and timeout handling for batch fetches has been +improved. Rate limiting is handled automatically with retry logic +in both the Jira and GitHub plugins. + +Confluence picks up token-based authentication and a new stat for +**modified pages**. Markdown output is now supported in the +Google and Koji plugins. + +The Pagure plugin handles timeouts and server errors more +gracefully, and closed pull requests are now tracked. A new stat +for **comments on Pagure** issues has been added. + +New plugins have been added for searching public mailing list +archives: **public-inbox** via `public-inbox`_ and +**hyperkitty** via Hyperkitty_. + +Numerous **pylint and code quality** fixes have been applied +across the codebase. Pre-commit hooks have been updated and the +test suite now runs in parallel with ``pytest-xdist``. + +.. _public-inbox: https://public-inbox.org/ +.. _Hyperkitty: https://gitlab.com/mailman/hyperkitty + + +did-0.21 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A new ``--format=markdown`` option has been added, providing +**Markdown output** alongside the existing plain text and wiki +formats. The Bodhi and Pagure plugins include Markdown support +as well. + +Header and footer sections now support defining **subitems**, so +that recurring subsections can be pre-filled in the report +template. + +The Google plugin setup instructions have been refreshed and the +``sphinx_rtd_theme`` is now used for the documentation. From ce1bcd597ff246cc191cfb35581301fa317bb222 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pl=C3=ADchal?= Date: Tue, 14 Jul 2026 17:23:14 +0200 Subject: [PATCH 2/2] Add pull request links to the release notes Co-Authored-By: Claude Opus 4.6 --- docs/releases.rst | 115 ++++++++++++++++++++++++++++------------------ 1 file changed, 71 insertions(+), 44 deletions(-) diff --git a/docs/releases.rst b/docs/releases.rst index f6a062f3..e25d511e 100644 --- a/docs/releases.rst +++ b/docs/releases.rst @@ -9,45 +9,52 @@ did-0.24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The first day of the week is now **configurable** via the -``week_start`` option in the ``[general]`` config section. This -is useful for teams and regions where the week starts on Sunday -or another day. Flexible matching is supported — full names or -three-letter abbreviations like ``sun`` or ``mon`` work. +``week_start`` option in the ``[general]`` config section +(`#474`_). This is useful for teams and regions where the week +starts on Sunday or another day. Flexible matching is supported +— full names or three-letter abbreviations like ``sun`` or +``mon`` work. The ``--width 0`` option can be used to produce reports with -unlimited line width. +unlimited line width (`#460`_). Tokens can now be fetched from an **external command** using the new ``token_command`` config option, enabling integration with -password managers such as 1Password or BitWarden. The option is -supported by all plugins that use token authentication. +password managers such as 1Password or BitWarden (`#469`_). The +option is supported by all plugins that use token authentication. + +.. _#474: https://github.com/psss/did/pull/474 +.. _#460: https://github.com/psss/did/pull/460 +.. _#469: https://github.com/psss/did/pull/469 did-0.23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Initial support for the Forgejo_ backend has been added with -stats for **created issues** and **created pull requests**. +stats for **created issues** and **created pull requests** +(`#452`_). Both GitHub and GitLab plugins now track pull/merge requests **authored by you and successfully merged**, a new stat alongside -the existing created and commented ones. +the existing created and commented ones (`#311`_). Jira Cloud is now a first-class citizen with dedicated -authentication and query handling, and Jira issues **with -worklogs** can be collected as well. +authentication and query handling (`#448`_), and Jira issues +**with worklogs** can be collected as well (`#429`_). -A new ``--full-message`` flag lets you include the complete body of -commits, pull requests and merge requests in the report instead of -just the summary line. +A new ``--full-message`` flag lets you include the complete body +of commits, pull requests and merge requests in the report +instead of just the summary line (`#446`_). -The GitLab plugin no longer fetches thousands of pages when the API -returns a large result set, and the default 60-second timeout has -been fixed. GitHub error responses are now handled gracefully, and -the ``commented_in_range`` filter works correctly. +The GitLab plugin no longer fetches thousands of pages when the +API returns a large result set (`#377`_), and the default +60-second timeout has been fixed (`#421`_). GitHub error +responses are now handled gracefully (`#408`_), and the +``commented_in_range`` filter works correctly (`#444`_). Parsing of the ``--config`` argument with whitespace has been -fixed. +fixed (`#437`_). Significant **typing and test coverage** improvements across the codebase: type hints have been added to ``base.py``, ``cli.py``, @@ -56,47 +63,67 @@ items plugins. New unit test suites cover the ``utils`` and ``stats`` modules. Python 3.14 is now supported. .. _Forgejo: https://forgejo.org/ +.. _#452: https://github.com/psss/did/pull/452 +.. _#311: https://github.com/psss/did/pull/311 +.. _#448: https://github.com/psss/did/pull/448 +.. _#429: https://github.com/psss/did/pull/429 +.. _#446: https://github.com/psss/did/pull/446 +.. _#377: https://github.com/psss/did/pull/377 +.. _#421: https://github.com/psss/did/pull/421 +.. _#408: https://github.com/psss/did/pull/408 +.. _#444: https://github.com/psss/did/pull/444 +.. _#437: https://github.com/psss/did/pull/437 did-0.22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``did last monday`` through ``did last sunday`` syntax now -works for quickly selecting a single past day by name. +works for quickly selecting a single past day by name (`#342`_). Stats collection now runs **in parallel** using a thread pool, -which noticeably speeds up reports that query many backends. The -report is completed even when individual plugins encounter errors. +which noticeably speeds up reports that query many backends +(`#390`_). The report is completed even when individual plugins +encounter errors. The GitHub plugin gains support for filtering by ``user``, -``org`` and ``repo``, an ``exclude_org`` option, and properly -collects comments. +``org`` and ``repo`` (`#373`_), an ``exclude_org`` option, and +properly collects comments. Rate limiting is handled +automatically with retry logic in both the GitHub (`#374`_) and +Jira plugins. -The Jira plugin received substantial improvements in this release. -A new ``transition`` stat tracks issues that moved between states. -Updated issues and issues resolved by a tester or contributor can -now be collected, and timeout handling for batch fetches has been -improved. Rate limiting is handled automatically with retry logic -in both the Jira and GitHub plugins. +The Jira plugin received substantial improvements in this +release. A new ``transition`` stat tracks issues that moved +between states (`#352`_). Updated issues and issues resolved by +a tester or contributor can now be collected, and timeout +handling for batch fetches has been improved. -Confluence picks up token-based authentication and a new stat for -**modified pages**. Markdown output is now supported in the -Google and Koji plugins. +Confluence picks up token-based authentication (`#365`_) and a +new stat for **modified pages**. Markdown output is now supported +in the Google (`#367`_) and Koji (`#359`_) plugins. The Pagure plugin handles timeouts and server errors more -gracefully, and closed pull requests are now tracked. A new stat -for **comments on Pagure** issues has been added. +gracefully, and closed pull requests are now tracked (`#390`_). +A new stat for **comments on Pagure** issues has been added. New plugins have been added for searching public mailing list -archives: **public-inbox** via `public-inbox`_ and -**hyperkitty** via Hyperkitty_. +archives: **public-inbox** (`#329`_) and **hyperkitty** +(`#388`_). Numerous **pylint and code quality** fixes have been applied across the codebase. Pre-commit hooks have been updated and the test suite now runs in parallel with ``pytest-xdist``. -.. _public-inbox: https://public-inbox.org/ -.. _Hyperkitty: https://gitlab.com/mailman/hyperkitty +.. _#342: https://github.com/psss/did/pull/342 +.. _#390: https://github.com/psss/did/pull/390 +.. _#373: https://github.com/psss/did/pull/373 +.. _#374: https://github.com/psss/did/pull/374 +.. _#352: https://github.com/psss/did/pull/352 +.. _#365: https://github.com/psss/did/pull/365 +.. _#367: https://github.com/psss/did/pull/367 +.. _#359: https://github.com/psss/did/pull/359 +.. _#329: https://github.com/psss/did/pull/329 +.. _#388: https://github.com/psss/did/pull/388 did-0.21 @@ -104,12 +131,12 @@ did-0.21 A new ``--format=markdown`` option has been added, providing **Markdown output** alongside the existing plain text and wiki -formats. The Bodhi and Pagure plugins include Markdown support -as well. +formats (`#315`_). The Bodhi and Pagure plugins include Markdown +support as well. Header and footer sections now support defining **subitems**, so that recurring subsections can be pre-filled in the report -template. +template (`#312`_). -The Google plugin setup instructions have been refreshed and the -``sphinx_rtd_theme`` is now used for the documentation. +.. _#315: https://github.com/psss/did/pull/315 +.. _#312: https://github.com/psss/did/pull/312