documentation review for release - #173
Merged
Merged
Conversation
- Fix CI badge in README (release.yml → ci.yml) - Update Gatekeeper: app is signed and notarized, no right-click needed - Resolve signing provider: Certum for Windows, Apple Developer ID for macOS - Add macOS signing section to codesigning.md (notarization + stapling) - Update softwareVersion in structured data (0.1.4 → 0.2.0.0) - Add ARM64 Linux to supported platforms - Fix .deb dependency list (only libxcb-cursor0 is declared) - Fix license text: GPL v3+ → LGPL v3.0 or later - Fix export-data cross-reference - Add Halifax to feature list - Update copyright year to 2025-2026 Closes #171
Closed
- Fix 8 broken bank_statement_parser guide URLs (missing /latest/ path segment) - Fix wrong slug in advanced-export.md (new-bank-config → exports) - Fix wrong slug in export-data.md (export-config → exports) - Create CHANGELOG.md with Keep a Changelog format, seeded with v0.2.0.0 - Add changelog auto-generation to release.yml (conventional commits → changelog) - Add Changelog entry to mkdocs.yml nav - Add commit message conventions to CONTRIBUTING.md and AGENTS.md
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
MkDocs navigation references a missing docs/changelog.md page, and the updated release workflow needs small but important fixes (action pinning consistency and safer markdown section separation).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the project’s documentation and release workflow to align with the upcoming v0.2.0.0 release, including corrected links, updated platform/signing guidance, and automated changelog generation for GitHub releases.
Changes:
- Fixes multiple documentation inaccuracies (code signing, licensing, supported platforms) and repairs broken
bank_statement_parserguide URLs. - Adds a Keep a Changelog–style
CHANGELOG.mdand updates MkDocs navigation to include a Changelog entry. - Enhances the release workflow to generate changelog notes from conventional commits and prepend them to GitHub Release notes alongside the VirusTotal table.
File summaries
| File | Description |
|---|---|
| README.md | Fixes CI badge URL and updates bank_statement_parser guide link to /latest/. |
| mkdocs.yml | Adds a Changelog entry to the docs navigation. |
| docs/screens/project-management.md | Updates bank_statement_parser guide link to /latest/. |
| docs/screens/import-statements.md | Updates “add a new bank” guide link to /latest/. |
| docs/screens/import-results.md | Updates “add a new bank” guide link to /latest/. |
| docs/screens/export-data.md | Fixes export docs cross-reference to the correct BSP exports guide. |
| docs/screens/advanced-export.md | Fixes export docs cross-reference to the correct BSP exports guide. |
| docs/screens/admin.md | Updates page description to match actual admin capabilities. |
| docs/screens/about.md | Updates licence wording to LGPL (but still needs copyright year alignment). |
| docs/quickstart.md | Updates “add a new bank” guide link to /latest/. |
| docs/privacy.md | Updates code signing provider details (Certum + Apple notarization). |
| docs/overrides/main.html | Updates structured data version and supported-bank feature list. |
| docs/installation.md | Updates Windows/macOS signing wording and Linux dependency/platform notes. |
| docs/index.md | Updates BSP guide link to /latest/, platform matrix, and copyright year. |
| docs/codesigning.md | Adds/expands macOS signing+notarization policy and clarifies Windows signing. |
| CONTRIBUTING.md | Documents Conventional Commits requirements. |
| CHANGELOG.md | Introduces a Keep a Changelog formatted changelog seeded for v0.2.0.0. |
| AGENTS.md | Documents Conventional Commits requirements for contributors/agents. |
| .github/workflows/release.yml | Adds changelog generation job and prepends changelog to release notes. |
Review details
- Files reviewed: 19/19 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Fix mkdocs.yml nav: changelog points to GitHub repo instead of missing docs page - Pin upload-artifact and download-artifact to commit SHAs for supply-chain safety - Add explicit newline separators between markdown sections in release body - Fix copyright year in about.md (2025 → 2025–2026)
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.
Review and update documentation for the next release.
Critical fixes:
release.ymlinstead ofci.ymlsoftwareVersionin structured data was0.1.4, now0.2.0.0Other improvements:
.debdependency list (onlylibxcb-cursor0is declared)Changelog & link fixes (latest):
Closes #171