Skip to content

Commit 0209a6f

Browse files
klmcadamspyansys-ci-bot
klmcadams
and
pyansys-ci-bot
authored
chore: Update changelog file and fragment files (#275)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 3f8492d commit 0209a6f

21 files changed

+430
-377
lines changed

‎.github/workflows/label.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,6 @@ jobs:
9898
- uses: ansys/actions/doc-changelog@main
9999
with:
100100
token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
101+
use-conventional-commits: true
101102
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
102103
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

‎CHANGELOG.md

Lines changed: 1 addition & 371 deletions
Large diffs are not rendered by default.

‎doc/changelog.d/257.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.0 to 1.2.1

‎doc/changelog.d/259.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.1 to 1.2.2

‎doc/changelog.d/260.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump pytest from 8.3.3 to 8.3.4

‎doc/changelog.d/263.maintenance.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
chore: Update code for reuse v5.0.2

‎doc/changelog.d/264.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.2 to 1.2.3

‎doc/changelog.d/266.maintenance.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
chore: Use `pathlib.Path` instead of `os` in add_license_headers.py

‎doc/changelog.d/267.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps): bump jinja2 from 3.1.4 to 3.1.5

‎doc/changelog.d/268.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.3 to 1.2.4

‎doc/changelog.d/269.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps): bump gitpython from 3.1.43 to 3.1.44

‎doc/changelog.d/270.dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build(deps-dev): bump sphinx-autodoc-typehints from 2.5.0 to 3.0.0

‎doc/changelog.d/271.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
fix: Update license headers and fix broken tests

‎doc/changelog.d/272.miscellaneous.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[pre-commit.ci] pre-commit autoupdate

‎doc/changelog.d/273.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
fix: Fix "success" statements being printed and LICENSE file updates

‎doc/changelog.d/275.maintenance.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update changelog file and fragment files

‎doc/changelog.d/changelog_template.jinja

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{% if sections[""] %}
22
{% for category, val in definitions.items() if category in sections[""] %}
33

4-
### {{ definitions[category]['name'] }}
4+
{{ definitions[category]['name'] }}
5+
{% set underline = '^' * definitions[category]['name']|length %}
6+
{{ underline }}
57

68
{% for text, values in sections[""][category].items() %}
79
- {{ text }} {{ values|join(', ') }}

‎doc/source/changelog.rst

Lines changed: 398 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/source/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
with open(str(version_file), "r") as file:
1919
__version__ = file.read().splitlines()[0]
2020
release = version = __version__
21+
switcher_version = get_version_match(version)
2122

2223
# Select desired theme, and declare the html title
2324
html_theme = "ansys_sphinx_theme"
@@ -105,3 +106,10 @@
105106
linkcheck_ignore = [
106107
"https://opensource.org/licenses/MIT",
107108
]
109+
110+
# If we are on a release, we have to ignore the "release" URLs, since it is not
111+
# available until the release is published.
112+
if switcher_version != "dev":
113+
linkcheck_ignore.append(
114+
f"https://github.com/ansys/pre-commit-hooks/releases/tag/v{__version__}"
115+
)

‎doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
:maxdepth: 3
1111

1212
api/index
13+
changelog

‎pyproject.toml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,11 @@ markers = [
4343
[tool.towncrier]
4444
package = "ansys.pre_commit_hooks"
4545
directory = "doc/changelog.d"
46-
filename = "CHANGELOG.md"
47-
start_string = "<!-- towncrier release notes start -->\n"
48-
underlines = ["", "", ""]
46+
filename = "doc/source/changelog.rst"
47+
start_string = ".. towncrier release notes start\n"
4948
template = "doc/changelog.d/changelog_template.jinja"
50-
title_format = "## [{version}](https://github.com/ansys/pre-commit-hooks/releases/tag/v{version}) - {project_date}"
51-
issue_format = "[#{issue}](https://github.com/ansys/pre-commit-hooks/pull/{issue})"
49+
title_format = "`{version} <https://github.com/ansys/pre-commit-hooks/releases/tag/v{version}>`_ - {project_date}"
50+
issue_format = "`#{issue} <https://github.com/ansys/pre-commit-hooks/pull/{issue}>`_"
5251

5352
[[tool.towncrier.type]]
5453
directory = "added"

0 commit comments

Comments
 (0)