Skip to content

Commit 0e08b26

Browse files
authored
πŸš€ Release v0.2.0 (#9)
1 parent e457d2f commit 0e08b26

File tree

4 files changed

+44
-5
lines changed

4 files changed

+44
-5
lines changed

β€Ždocs/conf.pyβ€Ž

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2525

2626
extensions = [
27+
"sphinx.ext.extlinks",
2728
"sphinx_needs",
2829
]
2930

@@ -69,3 +70,11 @@
6970

7071
# Sphinx-Needs configuration
7172
needs_from_toml = "ubproject.toml"
73+
74+
extlinks = {
75+
"pr": ("https://github.com/useblocks/needs-config-writer/pull/%s", "PR #%s"),
76+
"issue": (
77+
"https://github.com/useblocks/needs-config-writer/issues/%s",
78+
"issue #%s",
79+
),
80+
}

β€Ždocs/development/changelog.rstβ€Ž

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,40 @@
33
Changelog
44
=========
55

6-
.. _unreleased:
6+
..
7+
.. _unreleased:
78
8-
Unreleased
9-
----------
9+
Unreleased
10+
----------
11+
12+
.. _`release:0.2.0`:
13+
14+
0.2.0
15+
-----
16+
17+
:Released: 28.10.2025
18+
:Full Changelog: `v0.1.0...v0.2.0 <https://github.com/useblocks/needs-config-writer/compare/0.1.0...e457d2f>`__
19+
20+
This release reduce the complexity of content comparison and improves the configuration.
21+
It's not backwards compatible as most of the configuration changed. Please check the updated documentation.
22+
23+
- ♻️ Remove hash based comparison (:pr:`8`)
24+
25+
The configuration ``needscfg_use_hash`` was renamed to :ref:`config_warn_on_diff`.
26+
Hashing is not required as the content can be compared directly.
27+
This is simpler with less config and less dependencies.
28+
Default is ``True``.
29+
30+
:ref:`config_overwrite` now checks in all cases whether to overwrite differing files.
31+
Default is ``False`` to prevent accidental overwrites.
32+
33+
The configuration ``needscfg_write_defaults`` was renamed to :ref:`config_write_all`
34+
to be more explicit about what it does. If enabled, all known Sphinx-Needs configuration is written,
35+
including defaults and not only explicitly set values.
36+
Default is ``False``.
37+
38+
Fix sorting of ``needs_extra_options`` which maybe given as ``list[str]`` or ``list[dict]``.
39+
For the latter case it is sorted by the ``name`` key.
1040

1141
.. _`release:0.1.0`:
1242

β€Žneeds_config_writer/__init__.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Sphinx extension to write Sphinx-Needs config to ubproject.toml."""
22

3-
__version__ = "0.1.0"
3+
__version__ = "0.2.0"
44

55

66
def setup(app):

β€Žpyproject.tomlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
44

55
[project]
66
name = "needs-config-writer"
7-
version = "0.1.0"
7+
version = "0.2.0"
88
description = "Sphinx extension to write Sphinx-Needs config to ubproject.toml"
99
readme = "README.rst"
1010
urls.Repository = "https://github.com/useblocks/needs-config-writer"

0 commit comments

Comments
Β (0)