Skip to content

Commit 958b311

Browse files
FIX: Changelog settings (#5908)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 6448812 commit 958b311

File tree

4 files changed

+13
-126
lines changed

4 files changed

+13
-126
lines changed

CHANGELOG.md

Lines changed: 0 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,3 @@
1-
## [0.15.1](https://github.com/ansys/pyaedt/releases/tag/v0.15.1) - March 13, 2025
2-
3-
4-
.. tab-set::
5-
6-
.. tab-item:: Fixed
7-
8-
.. list-table::
9-
:header-rows: 0
10-
:widths: auto
11-
12-
13-
* - Unstable test fix due to FilterSolutions DLL
14-
- [#5843](https://github.com/ansys/pyaedt/pull/5843)
15-
16-
* - Licensingclient path update for version 252
17-
- [#5854](https://github.com/ansys/pyaedt/pull/5854)
18-
19-
.. tab-item:: Maintenance
20-
21-
.. list-table::
22-
:header-rows: 0
23-
:widths: auto
24-
25-
26-
* - Ensure bot uses upper case
27-
- [#5899](https://github.com/ansys/pyaedt/pull/5899)
28-
29-
* - Fix release workflow
30-
- [#5900](https://github.com/ansys/pyaedt/pull/5900)
31-
32-
## [0.15.1](https://github.com/ansys/pyaedt/releases/tag/v0.15.1) - March 12, 2025
33-
34-
No significant changes.
35-
## [0.15.1](https://github.com/ansys/pyaedt/releases/tag/v0.15.1) - March 11, 2025
36-
37-
38-
.. tab-set::
39-
40-
.. tab-item:: Added
41-
42-
.. list-table::
43-
:header-rows: 0
44-
:widths: auto
45-
46-
47-
* - Identify port in get coupling in range
48-
- [#5817](https://github.com/ansys/pyaedt/pull/5817)
49-
50-
* - Add AEDT File Management tests
51-
- [#5879](https://github.com/ansys/pyaedt/pull/5879)
52-
53-
* - Add excitations by type for Circuit interface ports
54-
- [#5880](https://github.com/ansys/pyaedt/pull/5880)
55-
56-
.. tab-item:: Dependencies
57-
58-
.. list-table::
59-
:header-rows: 0
60-
:widths: auto
61-
62-
63-
* - update ipython requirement from <8.34,>=7.30.0 to >=7.30.0,<9.1
64-
- [#5884](https://github.com/ansys/pyaedt/pull/5884)
65-
66-
* - update mock requirement from <5.2,>=5.1.0 to >=5.1.0,<5.3
67-
- [#5885](https://github.com/ansys/pyaedt/pull/5885)
68-
69-
.. tab-item:: Documentation
70-
71-
.. list-table::
72-
:header-rows: 0
73-
:widths: auto
74-
75-
76-
* - Add the changelog feature
77-
- [#5612](https://github.com/ansys/pyaedt/pull/5612)
78-
79-
.. tab-item:: Fixed
80-
81-
.. list-table::
82-
:header-rows: 0
83-
:widths: auto
84-
85-
86-
* - Created a new visualization folder
87-
- [#5881](https://github.com/ansys/pyaedt/pull/5881)
88-
89-
* - Back compatibility with Example repository
90-
- [#5888](https://github.com/ansys/pyaedt/pull/5888)
91-
92-
* - Update imported traces to trace property
93-
- [#5893](https://github.com/ansys/pyaedt/pull/5893)
94-
95-
.. tab-item:: Maintenance
96-
97-
.. list-table::
98-
:header-rows: 0
99-
:widths: auto
100-
101-
102-
* - Remove nightly unit test pre-release
103-
- [#5891](https://github.com/ansys/pyaedt/pull/5891)
104-
105-
* - Add mandatory token to github release step
106-
- [#5895](https://github.com/ansys/pyaedt/pull/5895)
107-
108-
.. tab-item:: Miscellaneous
109-
110-
.. list-table::
111-
:header-rows: 0
112-
:widths: auto
113-
114-
115-
* - Pathlib refactor: circuit.py
116-
- [#5842](https://github.com/ansys/pyaedt/pull/5842)
117-
1181
# CHANGELOG
1192

1203
This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs.

doc/changelog.d/5908.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Changelog settings

doc/changelog.d/changelog_template.jinja

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
{% if sections[""] %}
22

33
.. tab-set::
4-
{%+ for category, val in definitions.items() if category in sections[""] +%}
4+
5+
{%+ for category, val in definitions.items() if category in sections[""] %}
6+
57
.. tab-item:: {{ definitions[category]['name'] }}
68

79
.. list-table::
810
:header-rows: 0
911
:widths: auto
1012

11-
{%+ for text, values in sections[""][category].items() +%}
13+
{% for text, values in sections[""][category].items() %}
1214
* - {{ text }}
1315
- {{ values|join(', ') }}
14-
{% endfor %}
15-
{% endfor %}
16+
17+
{% endfor %}
18+
{% endfor %}
1619

1720
{% else %}
1821
No significant changes.

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ Documentation = "https://aedt.docs.pyansys.com"
145145
Source = "https://github.com/ansys/pyaedt"
146146
Discussions = "https://github.com/ansys/pyaedt/discussions"
147147
Releases = "https://github.com/ansys/pyaedt/releases"
148+
Changelog = "https://github.com/ansys/pyaedt/blob/main/doc/source/changelog.rst"
148149

149150
[tool.black]
150151
line-length = 120
@@ -217,12 +218,11 @@ exclude = [
217218
[tool.towncrier]
218219
package = "ansys.aedt.core"
219220
directory = "doc/changelog.d"
220-
filename = "CHANGELOG.md"
221-
start_string = "<!-- towncrier release notes start -->\n"
222-
underlines = ["", "", ""]
221+
filename = "doc/source/changelog.rst"
222+
start_string = ".. towncrier release notes start\n"
223223
template = "doc/changelog.d/changelog_template.jinja"
224-
title_format = "## [{version}](https://github.com/ansys/pyaedt/releases/tag/v{version}) - {project_date}"
225-
issue_format = "[#{issue}](https://github.com/ansys/pyaedt/pull/{issue})"
224+
title_format = "`{version} <https://github.com/ansys/pyaedt/releases/tag/v{version}>`_ - {project_date}"
225+
issue_format = "`#{issue} <https://github.com/ansys/pyaedt/pull/{issue}>`_"
226226

227227
[[tool.towncrier.type]]
228228
directory = "added"

0 commit comments

Comments
 (0)