Add release.sh script and simplify release workflow

- Create release.sh script with comprehensive pre-flight checks
- Script performs version bump, CHANGELOG update, tag creation, and atomic push
- Automatic rollback on push failure
- Simplify .github/workflows/release.yml to trigger on v* tags only
- Remove git operations from GitHub workflow (now done locally via script)
- Update CONTRIBUTING.md with new release process documentation
- Update BUILDING.md to reference release.sh script
- Filter automated commits from release changelog

Author: nickprotop

.github/workflows/release.yml

@@ -3,19 +3,7 @@ name: Release
 on:
   push:
     tags:
-      - 'release-patch'
-      - 'release-minor'
-      - 'release-major'
-  workflow_dispatch:
-    inputs:
-      bump_type:
-        description: 'Version bump type'
-        required: true
-        type: choice
-        options:
-          - patch
-          - minor
-          - major
+      - 'v*'  # Trigger on version tags (v0.6.4, v1.0.0, etc.)
 
 permissions:
   contents: write
@@ -29,10 +17,17 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: main  # Always checkout main branch, not the tag
           fetch-depth: 0  # Full history needed for changelog
           token: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Get version from tag
+        id: version
+        run: |
+          # Extract version from tag (v0.6.4 -> 0.6.4)
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Release version: $VERSION"
+
       - name: Setup .NET 9
         uses: actions/setup-dotnet@v3
         with:
@@ -41,29 +36,6 @@ jobs:
       - name: Install zip utility
         run: sudo apt-get update && sudo apt-get install -y zip
 
-      - name: Extract bump type from tag or input
-        id: bump
-        run: |
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            BUMP_TYPE="${{ inputs.bump_type }}"
-          else
-            BUMP_TYPE=${GITHUB_REF#refs/tags/release-}
-          fi
-          echo "type=$BUMP_TYPE" >> $GITHUB_OUTPUT
-          echo "Bump type: $BUMP_TYPE"
-
-      - name: Bump version in all files
-        run: |
-          chmod +x bump-version.sh get-version.sh
-          ./bump-version.sh ${{ steps.bump.outputs.type }} -y
-
-      - name: Get new version
-        id: version
-        run: |
-          VERSION=$(./get-version.sh)
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "New version: $VERSION"
-
       - name: Generate changelog from commits
         id: changelog
         run: |
@@ -93,44 +65,6 @@ jobs:
             echo "EOF"
           } >> $GITHUB_OUTPUT
 
-      - name: Update CHANGELOG.md
-        run: |
-          VERSION=${{ steps.version.outputs.version }}
-          DATE=$(date +%Y-%m-%d)
-
-          # Create new version section with current date
-          sed -i "s/## \[Unreleased\]/## [Unreleased]\n\n## [$VERSION] - $DATE/" CHANGELOG.md
-
-          # Update version comparison links at bottom
-          PREV_TAG=$(git describe --tags --abbrev=0 --match "v[0-9]*" HEAD^ 2>/dev/null || echo "")
-          if [ -n "$PREV_TAG" ]; then
-            # Update [Unreleased] link
-            sed -i "s|\[Unreleased\]:.*|[Unreleased]: https://github.com/${{ github.repository }}/compare/v$VERSION...HEAD|" CHANGELOG.md
-            # Add new version link
-            sed -i "/\[Unreleased\]:/a [$VERSION]: https://github.com/${{ github.repository }}/compare/${PREV_TAG}...v$VERSION" CHANGELOG.md
-          else
-            # First release
-            sed -i "/\[Unreleased\]:/a [$VERSION]: https://github.com/${{ github.repository }}/releases/tag/v$VERSION" CHANGELOG.md
-          fi
-
-      - name: Commit version changes
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add LocalizationManager.csproj CHANGELOG.md
-          git commit -m "Bump version to ${{ steps.version.outputs.version }} [skip ci]"
-
-      - name: Push version commit to main
-        run: |
-          git push origin HEAD:main
-          echo "✓ Pushed version commit to main"
-
-      - name: Create and push version tag
-        run: |
-          git tag -a "v${{ steps.version.outputs.version }}" -m "Release v${{ steps.version.outputs.version }}"
-          git push origin "v${{ steps.version.outputs.version }}"
-          echo "✓ Created and pushed tag v${{ steps.version.outputs.version }}"
-
       - name: Build all platforms
         run: |
           ./build.sh
@@ -169,9 +103,3 @@ jobs:
             publish/lrm-win-arm64.zip
           draft: false
           prerelease: false
-
-      - name: Delete release trigger tag
-        if: always()
-        run: |
-          git push origin --delete ${{ github.ref_name }} || true
-          echo "✓ Cleaned up trigger tag"

BUILDING.md

@@ -96,21 +96,37 @@ dotnet publish \
 Version is defined in `LocalizationManager.csproj`:
 
 ```xml
-<Version>0.6.0</Version>
-<AssemblyVersion>0.6.0.0</AssemblyVersion>
-<FileVersion>0.6.0.0</FileVersion>
+<Version>0.6.3</Version>
+<AssemblyVersion>0.6.3.0</AssemblyVersion>
+<FileVersion>0.6.3.0</FileVersion>
 ```
 
-To release a new version:
-1. Update version numbers in `.csproj`
-2. Update `VERSION` in `build.sh`
-3. Run `./build.sh`
-4. Test the executables
-5. Tag the release in git:
-   ```bash
-   git tag -a v0.6.0 -m "Release v0.6.0"
-   git push origin v0.6.0
-   ```
+### Creating a Release (Maintainers Only)
+
+Use the automated release script:
+
+```bash
+# Patch release (0.6.3 → 0.6.4)
+./release.sh patch
+
+# Minor release (0.6.3 → 0.7.0)
+./release.sh minor
+
+# Major release (0.6.3 → 1.0.0)
+./release.sh major
+```
+
+The script will:
+1. Verify working directory is clean and on main branch
+2. Check push permissions to remote
+3. Bump version in `LocalizationManager.csproj` and `CHANGELOG.md`
+4. Create version commit and tag (e.g., `v0.6.4`)
+5. Push atomically to GitHub
+6. Trigger GitHub Actions to build and create release
+
+**On failure:** All changes are automatically rolled back.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed release process documentation.
 
 ## Build Requirements
 
@@ -144,11 +160,9 @@ chmod +x publish/linux-x64/lrm
 
 Before releasing:
 - [ ] All tests passing (`dotnet test`)
-- [ ] Version updated in `.csproj` and `build.sh`
-- [ ] Build script runs successfully (`./build.sh`)
-- [ ] Linux executable tested (`./publish/linux-x64/lrm --version`)
-- [ ] Command functionality verified (`lrm validate --path TestData`)
-- [ ] Archives contain correct files
-- [ ] README files generated correctly
-- [ ] Git tag created
-- [ ] Release notes prepared
+- [ ] Working directory is clean (no uncommitted changes)
+- [ ] On main branch
+- [ ] Release script runs successfully (`./release.sh patch/minor/major`)
+- [ ] GitHub Actions workflow completes successfully
+- [ ] Release artifacts available on GitHub
+- [ ] Download and test released binaries

CONTRIBUTING.md

@@ -233,22 +233,46 @@ public void Validate_ShouldDetectMissingKeys_WhenTranslationIsMissing()
 
 ## Release Process
 
-Releases are fully automated via GitHub Actions:
+Releases are created using the `release.sh` script:
 
-1. Maintainer pushes a release tag: `git tag release-patch && git push origin release-patch`
-   - Use `release-patch` for bug fixes (0.6.2 → 0.6.3)
-   - Use `release-minor` for new features (0.6.2 → 0.7.0)
-   - Use `release-major` for breaking changes (0.6.2 → 1.0.0)
+**For Maintainers:**
 
-2. GitHub Actions workflow automatically:
-   - Bumps version in `.csproj` and `README.md`
+```bash
+# Create a patch release (0.6.3 → 0.6.4)
+./release.sh patch
+
+# Create a minor release (0.6.3 → 0.7.0)
+./release.sh minor
+
+# Create a major release (0.6.3 → 1.0.0)
+./release.sh major
+```
+
+**What the script does:**
+
+1. **Pre-flight checks:**
+   - Verifies working directory is clean
+   - Confirms you're on main branch
+   - Tests remote connection and push permissions
+
+2. **Version bump:**
+   - Bumps version in `LocalizationManager.csproj`
    - Updates `CHANGELOG.md` with new version and date
-   - Commits version changes back to main
-   - Creates version tag (e.g., `v0.6.3`)
-   - Runs all tests
-   - Builds all 4 platforms (Linux/Windows x64/ARM64)
-   - Creates GitHub release with binaries and changelog
-   - Cleans up the trigger tag
+   - Creates a commit with version changes
+
+3. **Tag and push:**
+   - Creates version tag (e.g., `v0.6.4`)
+   - Pushes commit and tag atomically to GitHub
+
+4. **On push failure:**
+   - Automatically rolls back all changes
+   - No manual cleanup needed
+
+**GitHub Actions then:**
+- Triggers on the version tag
+- Runs all tests
+- Builds all 4 platforms (Linux/Windows x64/ARM64)
+- Creates GitHub release with binaries and changelog
 
 **Note:** Contributors don't need to worry about version numbers or releases. Maintainers handle the release process.
 
@@ -308,19 +332,17 @@ git commit -m "Added new export format"
 
 ### 3. Release Workflow (`.github/workflows/release.yml`)
 
-**Triggers:** Push of special tags: `release-patch`, `release-minor`, `release-major`
+**Triggers:** Push of version tags (e.g., `v0.6.4`, `v1.0.0`)
 
 **What it does:**
-- Bumps version in `.csproj` and `README.md`
-- Updates CHANGELOG.md with version and date
-- Commits version changes
-- Creates version tag (e.g., `v0.6.3`)
+- Extracts version from tag
+- Generates changelog from commits since last release
 - Runs all tests
-- Builds all 4 platforms
-- Creates GitHub release with binaries
-- Cleans up trigger tag
+- Builds all 4 platforms (Linux/Windows x64/ARM64)
+- Creates archives with static filenames (lrm-linux-x64.tar.gz, etc.)
+- Creates GitHub release with binaries and changelog
 
-**Note:** Only maintainers trigger releases.
+**Note:** Version tags are created by the `release.sh` script. Only maintainers create releases.
 
 ## Development Workflow
 
@@ -382,7 +404,7 @@ git pull upstream main  # or: git pull origin main
 ```
 
 **Also pull after releases:**
-- When a maintainer creates a release, version files are updated
+- When a maintainer creates a release, `LocalizationManager.csproj` and `CHANGELOG.md` are updated
 - Always sync before starting new work to avoid conflicts
 
 ### Commit Message Best Practices