Skip to content

Commit e1d1de7

Browse files
committed
doc and script fixes. Pushing v0.15.0
1 parent 9d57abe commit e1d1de7

File tree

4 files changed

+35
-16
lines changed

4 files changed

+35
-16
lines changed

.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.14.0
1+
0.15.0

Directory.Build.props

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project>
22
<PropertyGroup>
3-
<Version>0.14.0</Version>
4-
<AssemblyVersion>0.14.0.0</AssemblyVersion>
5-
<FileVersion>0.14.0.0</FileVersion>
3+
<Version>0.15.0</Version>
4+
<AssemblyVersion>0.15.0.0</AssemblyVersion>
5+
<FileVersion>0.15.0.0</FileVersion>
66
</PropertyGroup>
77
</Project>

docs/VERSIONING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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

2627
Use 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

3237
This 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

3742
All 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

4156
Use semantic versioning: `MAJOR.MINOR.PATCH`

scripts/update-version.sh

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
#!/bin/bash
22

3+
# Get the directory where this script is located
4+
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
5+
PROJECT_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )"
6+
37
if [ $# -eq 0 ]; then
4-
echo "Usage: ./update-version.sh <new-version>"
5-
echo "Example: ./update-version.sh 0.11.0"
8+
echo "Usage: $0 <new-version>"
9+
echo "Example: $0 0.11.0"
610
exit 1
711
fi
812

@@ -15,15 +19,15 @@ fi
1519

1620
echo "Updating version to $NEW_VERSION..."
1721

18-
echo "$NEW_VERSION" > ../.version
22+
echo "$NEW_VERSION" > "$PROJECT_ROOT/.version"
1923

20-
sed -i.bak "s|<Version>.*</Version>|<Version>$NEW_VERSION</Version>|g" ../Directory.Build.props
21-
sed -i.bak "s|<AssemblyVersion>.*</AssemblyVersion>|<AssemblyVersion>$NEW_VERSION.0</AssemblyVersion>|g" ../Directory.Build.props
22-
sed -i.bak "s|<FileVersion>.*</FileVersion>|<FileVersion>$NEW_VERSION.0</FileVersion>|g" ../Directory.Build.props
23-
rm ../Directory.Build.props.bak
24+
sed -i.bak "s|<Version>.*</Version>|<Version>$NEW_VERSION</Version>|g" "$PROJECT_ROOT/Directory.Build.props"
25+
sed -i.bak "s|<AssemblyVersion>.*</AssemblyVersion>|<AssemblyVersion>$NEW_VERSION.0</AssemblyVersion>|g" "$PROJECT_ROOT/Directory.Build.props"
26+
sed -i.bak "s|<FileVersion>.*</FileVersion>|<FileVersion>$NEW_VERSION.0</FileVersion>|g" "$PROJECT_ROOT/Directory.Build.props"
27+
rm "$PROJECT_ROOT/Directory.Build.props.bak"
2428

25-
sed -i.bak "s|Version [0-9]\+\.[0-9]\+\.[0-9]\+|Version $NEW_VERSION|g" ../README.md
26-
rm ../README.md.bak
29+
sed -i.bak "s|Version [0-9]\+\.[0-9]\+\.[0-9]\+|Version $NEW_VERSION|g" "$PROJECT_ROOT/README.md"
30+
rm "$PROJECT_ROOT/README.md.bak"
2731

2832
echo "✓ Version updated to $NEW_VERSION"
2933
echo ""

0 commit comments

Comments
 (0)