Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces bumpver for semantic versioning and automated version management, while fixing PyPI publishing workflows. The changes move from manual version updates to a tool-based approach and update package metadata to improve compliance with Python packaging standards.
Changes:
- Configured
bumpverfor automated version management with semantic versioning - Updated package metadata in
pyproject.tomlto use string-based license format and include additional license files - Modified GitHub Actions workflow to update README links before building packages
- Removed the README from the package source (keeping only the root README)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/pn5180_tagomatic/README.md | Removed package-level README, consolidating documentation to root |
| pyproject.toml | Added bumpver configuration, updated license format, reordered dev dependencies, and configured version file patterns |
| MANIFEST.in | Updated to include REUSE.toml and tests directory while removing .ino files and .reuse/dep5 |
| .github/workflows/publish.yml | Removed manual version update logic and added README link updating step |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.github/workflows/publish.yml
Outdated
| BASE_URL = "https://github.com/bofh69/PN5180-tagomatic/tree/$VERSION" | ||
| sed -i "s#](\\([^h]\\)#$BASE_URL/\\1#" README.md |
There was a problem hiding this comment.
The sed command references $BASE_URL but it won't be expanded correctly due to the assignment error on the previous line. Additionally, the regex pattern appears to be attempting to match markdown links but may not work as intended. The pattern should likely be s#](\\([^h][^)]*\\))#]($BASE_URL/\\1)#g to properly match relative links and avoid matching links that start with 'h' (like http/https).
| BASE_URL = "https://github.com/bofh69/PN5180-tagomatic/tree/$VERSION" | |
| sed -i "s#](\\([^h]\\)#$BASE_URL/\\1#" README.md | |
| BASE_URL="https://github.com/bofh69/PN5180-tagomatic/tree/$VERSION" | |
| sed -i 's#](\([^h][^)]*\))#]('"$BASE_URL"'/\1)#g' README.md |
d56939c to
35aacfa
Compare
bumpver is now used to update the versions and tag a new release, using semantic versioning formatted tags in the future.
README.md's links are updated by the workflow job before building to link to github's tag tree for the new tag.