You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+50Lines changed: 50 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,56 @@ Changes for the upcoming release can be found in the
21
21
22
22
.. towncrier release notes start
23
23
24
+
Version 0.16.0
25
+
==============
26
+
27
+
Breaking Changes
28
+
----------------
29
+
30
+
- Standardized environment configuration keys in ``env.toml``.
31
+
All temporary paths now use the ``tmp_`` prefix (for example, ``tmp_repo_dir`` instead of ``temp_repo_dir``).
32
+
All directory-related keys now consistently use the ``_dir`` suffix, and previous ``_path`` aliases have been removed. (:gh:`102`)
33
+
34
+
35
+
Improved Documentation
36
+
----------------------
37
+
38
+
- Added a comprehensive technical reference for environment configuration keys and a User Guide section for the ``docbuild config env`` subcommand. (:gh:`110`)
39
+
- Updated the documentation copyright year and manifest timestamps, and added Sushant Gaurav in authors list. (:gh:`159`)
40
+
41
+
42
+
Features
43
+
--------
44
+
45
+
- Added :command:`check files` subcommand to verify that all DC files defined in XML configurations exist in their respective remote repositories. The implementation includes an optimization to group checks by repository, significantly reducing Git network overhead. (:gh:`78`)
46
+
- Implemented a "smart" :class:`~docbuild.models.serverroles.ServerRole` enum that accepts case-insensitive or abbreviated aliases like ``p``, ``prod``, or ``PRODUCTION``. The new value ``devel`` is an alias for ``testing``.
47
+
Refactor CLI error handling to display Pydantic validation failures in a clean, structured format. (:gh:`113`)
48
+
49
+
50
+
Infrastructure
51
+
--------------
52
+
53
+
- Enabled Python 3.14 for GitHub Action (:gh:`131`)
54
+
- Enabled GitHub Action for Dependabot config validation. (:gh:`144`)
55
+
- Fix permission issue in forks for coverage comment. (:gh:`148`)
56
+
57
+
58
+
Code Refactoring
59
+
----------------
60
+
61
+
- Refactored environment configuration to separate static path placeholders from runtime dynamic placeholders. This prevents invalid directory creation during configuration validation. (:gh:`108`)
62
+
- Refactored JSON structure for robust metadata handling in :func:`~docserv.cli.cmd_metadata.metaprocess.store_productdocset_json`. Introduce Pydantic :class:`~docbuild.models.manifest.Manifest` model to encapsulate document metadata, enhancing validation and serialization. (:gh:`140`)
63
+
- Refactored how Git repository URLs are parsed and handled.
64
+
Previously, multiple regular expressions were used to identify different
65
+
URL formats (like HTTPS, SSH, plain, and abbreviated notations).
66
+
These have now been consolidated into a single, more robust regular expression.
67
+
68
+
Additionally, the :class:`~docbuild.models.repo.Repo` class was
69
+
enhanced with new attributes (:attr:`~docbuild.models.repo.Repo.branch`,
70
+
:attr:`~docbuild.models.repo.Repo.origin`,
71
+
:attr:`~docbuild.models.repo.Repo.treeurl`) to better manage repository details. (:gh:`167`)
0 commit comments