Skip to content

Commit 6c134d3

Browse files
authored
🐛 fix(release): generate docstrfmt-compatible changelog entries (#463)
1 parent 3fdb23e commit 6c134d3

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

.github/workflows/release.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ jobs:
8181
git config user.name "${{ github.actor }}"
8282
git config user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
8383
header=" $VERSION ($(date -u +%Y-%m-%d))"
84-
separator=$(printf '%0.s*' $(seq 1 ${#header}))
84+
separator=$(printf '%0.s*' $(seq 1 $((${#header} + 1))))
8585
{
8686
head -4 docs/changelog.rst
87-
printf '%s\n%s\n%s\n%s\n\n' "$separator" "$header" "$separator" "$CHANGELOG"
87+
printf '%s\n%s\n%s\n\n%s\n\n' "$separator" "$header" "$separator" "$CHANGELOG"
8888
tail -n +5 docs/changelog.rst
8989
} > docs/changelog.tmp
9090
mv docs/changelog.tmp docs/changelog.rst

docs/changelog.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
Changelog
33
###########
44

5-
*******************
5+
********************
66
4.9.4 (2026-03-05)
7-
*******************
7+
********************
8+
89
- [pre-commit.ci] pre-commit autoupdate :pr:`461` - by :user:`pre-commit-ci[bot]`
910
- Update README.md
1011
- 📝 docs: add project logo to documentation :pr:`459`

tasks/changelog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def run() -> None:
6161

6262

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

0 commit comments

Comments
 (0)