Skip to content

Commit 4e78804

Browse files
committed
Use native Markdown for release notes and changelog history
1 parent c4821b3 commit 4e78804

55 files changed

Lines changed: 157 additions & 249 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/release.yml‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,27 +47,18 @@ jobs:
4747
env:
4848
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4949

50-
# towncrier writes the rendered notes to stdout (informational
51-
# chatter goes to stderr), so this is the curated release body for
52-
# this version, not github-tag-action's commit-derived changelog.
53-
- name: Generate the GitHub release notes
50+
- name: Assemble native Markdown release notes
5451
env:
5552
RELEASE: ${{ steps.calver.outputs.release }}
56-
run: uv run --group=release towncrier build --draft --version "$RELEASE" >
57-
release-notes.md
58-
59-
# Assemble the same fragments into CHANGELOG.rst under a new
60-
# ``$RELEASE`` section and delete the consumed fragment files.
61-
- name: Update the changelog
62-
env:
63-
RELEASE: ${{ steps.calver.outputs.release }}
64-
run: uv run --group=release towncrier build --yes --version "$RELEASE"
53+
run: |
54+
uv run --group=release towncrier build --yes --version "$RELEASE"
55+
cp "docs/source/changelog/$RELEASE.md" release-notes.md
6556
6657
- uses: stefanzweifel/git-auto-commit-action@v7
6758
id: commit
6859
with:
6960
commit_message: Bump CHANGELOG
70-
file_pattern: CHANGELOG.rst newsfragments
61+
file_pattern: CHANGELOG.md docs/source/changelog newsfragments
7162
# Error if there are no changes.
7263
skip_dirty_check: true
7364

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions

‎CHANGELOG.rst‎

Lines changed: 0 additions & 180 deletions
This file was deleted.

‎docs/source/changelog.md‎

Lines changed: 11 additions & 0 deletions

‎docs/source/changelog.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 3 additions & 0 deletions
Lines changed: 3 additions & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 3 additions & 0 deletions
Lines changed: 5 additions & 0 deletions

0 commit comments

Comments
 (0)