Conversation
Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
- Delete 39 pre-release tags (v0.2.0a*, v0.2.1a*, v0.2.1b*, v0.2.1rc*, v0.3.0a3) - Add towncrier for fragment-based changelog management - Create initial CHANGELOG.md with curated v0.3.0 section - Configure changes/ directory with Jinja template and 8 fragment types - Bump version from 0.2.1rc13 to 0.3.0 - Update release.yml: add towncrier build + changelog commit steps, use changelog as GitHub Release body - Add changelog page to mkdocs nav via symlink Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
chore: clean up release history, add towncrier changelog, bump to v0.3.0
Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the uk-bank-statement-parser project for the v0.3.0 release by bumping the package version, introducing Towncrier-based changelog management, and updating documentation and GitHub Actions release automation to publish artifacts and release notes.
Changes:
- Bump project version to
0.3.0and refresh project metadata (classifiers, keywords, URLs). - Add Towncrier (config + template + dev dependency) and introduce a generated
CHANGELOG.md. - Update docs navigation and enhance the release workflow (tag ancestry check, changelog generation, release body from changelog).
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
uv.lock |
Locks towncrier and updates the project version entry to 0.3.0. |
pyproject.toml |
Bumps version, updates metadata, adds Towncrier configuration and dev dependency. |
mkdocs.yml |
Adds a “Changelog” entry to the MkDocs navigation. |
changes/.gitkeep |
Ensures the Towncrier fragments directory exists in git. |
changes/_template.md.jinja |
Adds a Towncrier changelog rendering template. |
CHANGELOG.md |
Introduces the changelog file and initial 0.3.0 entry. |
.github/workflows/release.yml |
Adds tag-on-release-branch verification, Towncrier build + commit steps, and uses extracted changelog for GitHub release notes. |
.github/workflows/ci.yml |
Expands PR CI coverage to include the release branch. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
55
to
59
| nav: | ||
| - Home: index.md | ||
| - Quick Start: guides/quick-start.md | ||
| - Changelog: changelog.md | ||
| - Contributing: |
Comment on lines
+261
to
+265
| - name: Checkout | ||
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 | ||
| with: | ||
| ref: main | ||
|
|
Comment on lines
+272
to
+275
| if [ ! -s release_notes.md ]; then | ||
| echo "## What's Changed" > release_notes.md | ||
| echo "See [CHANGELOG.md](https://github.com/boscorat/bank_statement_parser/blob/main/CHANGELOG.md) for details." >> release_notes.md | ||
| fi |
Comment on lines
+95
to
+100
| git config user.name "github-actions[bot]" | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git add CHANGELOG.md changes/ | ||
| git diff --cached --quiet || git commit -m "docs: changelog for v${{ steps.version.outputs.version }}" | ||
| git push origin HEAD | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.