bcgov / bcgov/nr-objectstore-util
Improve versioning for package
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Current process:
* code is checked out
* dev dependencies are installed
* use hatch to calculate current version and next version
* update version using hatch in __about__.py
* build the package
* upload package
* commit changes made in __about__.py to the repo.
Future process:
* use [github releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) for versions
* eliminate use of __about__.py to cache the version
[spar example](https://github.com/bcgov/nr-spar-backend/blob/main/.github/workflows/merge-main.yml)
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the current packaging workflow, the version cache in __about__.py, and the linked GitHub Releases guidance; compare the intended approach with the spar example workflow. Done means releases provide the package version, the __about__.py update and commit are no longer needed, and the package still builds and uploads successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- build-system, release
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100