@@ -11,7 +11,7 @@ Version is defined in a few central locations and automatically propagated throu
1111 - Used by: .NET build system, F# assemblies
1212 - Provides: Assembly version, file version, product version
1313
14- 3 . ** ` README.md ` ** - Manually updated for documentation
14+ 3 . ** ` README.md ` ** - Automatically updated by the version script
1515 - Shows the current version to users
1616
1717## How Versions Are Used
@@ -20,22 +20,37 @@ Version is defined in a few central locations and automatically propagated throu
2020- ** Makefile** : Reads from ` .version ` file via ` $(shell cat .version) `
2121- ** Docker Compose** : Uses ` ${VERSION} ` environment variable set by Makefile
2222- ** Export Metadata** : Automatically includes version in exported JSONL files
23+ - ** GitHub Releases** : Uses version from ` Directory.Build.props ` plus build number (e.g., ` v0.14.0-11 ` )
2324
2425## Updating the Version
2526
2627Use the provided script to update all version references:
2728
2829``` bash
30+ # Can be run from any directory
31+ ./scripts/update-version.sh 0.11.0
32+
33+ # Or from within scripts directory
2934./update-version.sh 0.11.0
3035```
3136
3237This will update:
3338- ` .version ` file
34- - ` Directory.Build.props `
35- - ` README.md `
39+ - ` Directory.Build.props ` (Version, AssemblyVersion, FileVersion)
40+ - ` README.md ` (all "Version X.Y.Z" references)
3641
3742All other references will automatically pick up the new version.
3843
44+ ## GitHub Release Versioning
45+
46+ The GitHub Actions workflow creates releases with the format: ` v{version}-{run_number} `
47+
48+ For example:
49+ - Local version: ` 0.14.0 `
50+ - GitHub release: ` v0.14.0-11 ` (where 11 is the GitHub Actions run number)
51+
52+ This ensures each release is unique even if the version hasn't changed.
53+
3954## Version Format
4055
4156Use semantic versioning: ` MAJOR.MINOR.PATCH `
0 commit comments