Skip to content

🐛 fix(release): generate docstrfmt-compatible changelog entries #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaborbernat merged 1 commit into from
Mar 5, 2026
+6 −5
Merged

🐛 fix(release): generate docstrfmt-compatible changelog entries #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ jobs:
git config user.name "${{ github.actor }}"
git config user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
header=" $VERSION ($(date -u +%Y-%m-%d))"
separator=$(printf '%0.s*' $(seq 1 ${#header}))
separator=$(printf '%0.s*' $(seq 1 $((${#header} + 1))))
{
head -4 docs/changelog.rst
printf '%s\n%s\n%s\n%s\n\n' "$separator" "$header" "$separator" "$CHANGELOG"
printf '%s\n%s\n%s\n\n%s\n\n' "$separator" "$header" "$separator" "$CHANGELOG"
tail -n +5 docs/changelog.rst
} > docs/changelog.tmp
mv docs/changelog.tmp docs/changelog.rst
Expand Down
5 changes: 3 additions & 2 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
Changelog
###########

*******************
********************
4.9.4 (2026-03-05)
*******************
********************

- [pre-commit.ci] pre-commit autoupdate :pr:`461` - by :user:`pre-commit-ci[bot]`
- Update README.md
- 📝 docs: add project logo to documentation :pr:`459`
Expand Down
2 changes: 1 addition & 1 deletion tasks/changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def run() -> None:


def _load_excluded_authors() -> set[str]:
release_config = ROOT / ".github" / "release.yml"
release_config = ROOT / ".github" / "release.yaml"
if release_config.exists():
with release_config.open(encoding="utf-8") as file_handler:
config = yaml.safe_load(file_handler)
Expand Down