Skip to content

Commit 5838b88

Browse files
authored
Release/0.17.0 (#212)
* Update uv.lock * Bumping version: 0.16.0 → 0.17.0
1 parent 8e463b0 commit 5838b88

34 files changed

Lines changed: 747 additions & 413 deletions

CHANGELOG.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,59 @@ Changes for the upcoming release can be found in the
2121

2222
.. towncrier release notes start
2323
24+
Version 0.17.0
25+
==============
26+
27+
Improved Documentation
28+
----------------------
29+
30+
- Describe some missing features:
31+
32+
* Document the command :command:`docbuild check files` in the new seciton
33+
"Checking your Environment"
34+
* Add Pydantic definition into glossary
35+
* Adjusted "Configuring the Tool" section and included placeholders
36+
(static & dynamic), key naming conventions, and more. (:gh:`173`)
37+
- Streamlined CLI subcommands by removing redundant environment configuration
38+
checks and implementing strict typing with EnvConfig models.
39+
Updated :class:`~docbuild.utils.git.ManagedGitRepo` to support both string
40+
and :class:`~docbuild.models.repo.Repo` model initialization. (:gh:`181`)
41+
42+
43+
Features
44+
--------
45+
46+
- Add serialization of missing :class:`~docserv.models.deliverable.Description`. (:gh:`155`)
47+
- Added a rich-formatted Pydantic validation error reporter for the CLI, providing field descriptions, expected values, and documentation links. (:gh:`158`)
48+
- Implement manifest parity with legacy JSON portal configuration, including support for nested product metadata collection, full locale (BCP 47) support, and a new manifest audit utility for structural verification. (:gh:`183`)
49+
- Introduce the ``max_workers`` configuration key in the application config. This allows users to define concurrency limits using integers or hardware-aware keywords such as ``all``, ``half``, or ``all2``. (:gh:`189`)
50+
- Add a global CLI option ``-j``/``--workers`` to manage concurrency. This option overrides the configuration file and supports both explicit integer values and dynamic keywords (``all``, ``half``, ``all2``). (:gh:`190`)
51+
- Add a producer/consumer model implementation. (:gh:`191`)
52+
- Enhance metadata pipeline resilience by implementing default values for missing legacy fields and added a comprehensive suite of catalog-wide audit tools. (:gh:`192`)
53+
54+
55+
Infrastructure
56+
--------------
57+
58+
- Integrated GitHub CodeQL for automated security scanning and data-flow analysis of Python source code. (:gh:`164`)
59+
- Improve test coverage for :file:`git.py`, :file:`env.py`, and
60+
:file:`lifecycle.py`. Raises coverage report by 1%. (:gh:`168`)
61+
- Added a project security policy (SECURITY.md) to define a coordinated disclosure process for reporting vulnerabilities. (:gh:`179`)
62+
- Print more information from the setup-uv step. (:gh:`186`)
63+
- In the bug reporting template, remove "Windows" and add "Generic". (:gh:`196`)
64+
- Add :file:`AGENTS.md` for guiding coding agents. (:gh:`203`)
65+
- Switch the Ubuntu CI toolchain to use the modernized ``doc-container`` hosted on GitHub Container Registry (GHCR), providing Python 3.12 support and improved build reliability. (:gh:`205`)
66+
67+
68+
Code Refactoring
69+
----------------
70+
71+
- The implementation of :func:`~docbuild.config.app.deep_merge` has been
72+
fixed to properly handle deep copies of lists, tuples, and sets.
73+
Refactored to be more robust and handle a wider variety of data types
74+
(including lists, tuples, and sets) correctly during the merging process. (:gh:`202`)
75+
76+
2477
Version 0.16.0
2578
==============
2679

changelog.d/155.feature.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelog.d/158.feature.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelog.d/164.infra.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelog.d/168.infra.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

changelog.d/173.doc.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

changelog.d/179.infra.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelog.d/181.doc.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

changelog.d/183.feature.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelog.d/186.infra.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)