colin
/
ploughshares
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md to reflect current version management system
ci/woodpecker/push/woodpecker Pipeline was successful Details

This commit is contained in:
colin 2025-07-03 13:36:35 -04:00
parent 5d0dc3d29a
commit 4e1cad7a14
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -85,9 +85,10 @@ The application provides a RESTful API for managing transactions. See the API do
The application uses semantic versioning (X.Y.Z) with the following components:
- The `VERSION` file is the single source of truth for the application version
- The `VERSION` file at the root of the repository is the single source of truth for the application version
- The web UI and application automatically read the version from this file
- Version changes are managed using the `versionbump.sh` script
- A pre-commit hook ensures version consistency across files
- A version history log is maintained in `version_history.log`
### Version Bump Script
@ -114,10 +115,12 @@ The `versionbump.sh` script provides the following commands:
The version is maintained in:
- `VERSION` file (source of truth)
- Docker Compose environment variables
- Application log messages
- Docker Compose environment variables (APP_VERSION)
The pre-commit hook runs `tests/test_version.py` to verify consistency before allowing commits.
The application reads the version from:
1. The APP_VERSION environment variable if set
2. The VERSION file in the current directory
3. The VERSION file at the root of the repository
## Code Quality and Security