Merge pull request #5 from Corneloues/copilot/update-github-actions-workflows

Add pre-release support to GitHub Actions workflows

Author: Corneloues

.github/workflows/build-mmip.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+    tags:
+      - 'v*.*.*'           # Stable version tags
+      - 'v*.*.*-*'         # Pre-release tags (beta, alpha, rc)
   workflow_dispatch:
 
 permissions:
@@ -78,17 +81,21 @@ jobs:
           Write-Host "✅ Created MMIP: build/Soundchaser-TagTools.mmip"
         shell: pwsh
 
-      # 7. Commit and push to repo
-      - name: Commit and push build artifacts
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add -f build/Soundchaser-TagTools.zip build/Soundchaser-TagTools.mmip
-          git add src/info.json
-          git diff --quiet && git diff --staged --quiet || (git commit -m "Update build artifacts [skip ci]" && git push)
-        shell: pwsh
+      # 7. Create GitHub Release (only for version tags)
+      - name: Create GitHub Release
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            build/Soundchaser-TagTools.mmip
+            build/Soundchaser-TagTools.zip
+          generate_release_notes: true
+          draft: false
+          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      # 8. Upload as artifacts (optional backup)
+      # 8. Upload as artifacts (for non-tagged builds)
       - name: Upload MMIP artifact as ZIP
         uses: actions/upload-artifact@v4
         with:

.github/workflows/bump-version.yml

@@ -11,6 +11,20 @@ on:
           - patch
           - minor
           - major
+      prerelease_type:
+        description: 'Pre-release type (leave empty for stable)'
+        required: false
+        type: choice
+        options:
+          - ''
+          - alpha
+          - beta
+          - rc
+      prerelease_number:
+        description: 'Pre-release number (e.g., 1 for beta.1)'
+        required: false
+        type: string
+        default: '1'
 
 permissions:
   contents: write
@@ -36,7 +50,11 @@ jobs:
         id: new_version
         run: |
           CURRENT="${{ steps.get_version.outputs.current }}"
-          IFS='.' read -r -a parts <<< "$CURRENT"
+          
+          # Strip any existing pre-release suffix (e.g., 1.0.0-beta.1 -> 1.0.0)
+          BASE_VERSION="${CURRENT%%-*}"
+          
+          IFS='.' read -r -a parts <<< "$BASE_VERSION"
           
           # Validate version format
           if [ ${#parts[@]} -ne 3 ]; then
@@ -70,6 +88,12 @@ jobs:
           esac
           
           NEW_VERSION="$MAJOR.$MINOR.$PATCH"
+          
+          # Add pre-release suffix if specified
+          if [ -n "${{ inputs.prerelease_type }}" ]; then
+            NEW_VERSION="$NEW_VERSION-${{ inputs.prerelease_type }}.${{ inputs.prerelease_number }}"
+          fi
+          
           echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
           echo "New version: $NEW_VERSION"
 
@@ -98,5 +122,8 @@ jobs:
           echo "- **Previous version:** ${{ steps.get_version.outputs.current }}" >> $GITHUB_STEP_SUMMARY
           echo "- **New version:** ${{ steps.new_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
           echo "- **Bump type:** ${{ inputs.version_type }}" >> $GITHUB_STEP_SUMMARY
+          if [ -n "${{ inputs.prerelease_type }}" ]; then
+            echo "- **Pre-release:** ${{ inputs.prerelease_type }}.${{ inputs.prerelease_number }}" >> $GITHUB_STEP_SUMMARY
+          fi
           echo "" >> $GITHUB_STEP_SUMMARY
           echo "A new release will be created automatically." >> $GITHUB_STEP_SUMMARY

CONTRIBUTING.md

@@ -1,5 +1,91 @@
 # Contributing to Soundchaser-TagTools
 
+## Build and Release States
+
+This project uses different workflows depending on your intent:
+
+### 1. Development Builds (No Release)
+
+**Use case:** Daily development, experiments, testing locally
+
+**How:**
+- Just commit and push to `main`
+- No tag needed
+
+**What happens:**
+- ✅ Workflow builds the `.mmip` file
+- ✅ Uploaded as a workflow artifact (available for 90 days)
+- ❌ No GitHub Release created
+- ❌ Users don't see it
+
+**Download:** Go to Actions tab → Click workflow run → Download artifact
+
+---
+
+### 2. Pre-Release (Beta/Alpha Testing)
+
+**Use case:** Share with testers before official release
+
+**Version format:** `v1.0.0-beta.1`, `v1.0.0-alpha.1`, `v1.0.0-rc.1`
+
+**How to create via GitHub Actions:**
+1. Go to **Actions** → **Bump Version**
+2. Click **Run workflow**
+3. Select version type (`patch`, `minor`, `major`)
+4. Select pre-release type (`alpha`, `beta`, or `rc`)
+5. Enter pre-release number (e.g., `1`)
+6. Click **Run workflow**
+
+**What happens:**
+- ✅ Creates a GitHub Release
+- ⚠️ Marked as "Pre-release" (orange badge)
+- ❌ NOT marked as "Latest Release"
+- ✅ Can be downloaded from Releases page
+- ✅ Testers know it's not stable
+
+---
+
+### 3. Stable Release (Production)
+
+**Use case:** Official, production-ready version for all users
+
+**Version format:** `v1.0.0` (no suffix)
+
+**How to create via GitHub Actions:**
+1. Go to **Actions** → **Bump Version**
+2. Click **Run workflow**
+3. Select version type (`patch`, `minor`, `major`)
+4. Leave pre-release type empty
+5. Click **Run workflow**
+
+**What happens:**
+- ✅ Creates a GitHub Release
+- ✅ Marked as "Latest Release" (green badge)
+- ✅ Shown on repository homepage
+- ✅ Available at stable URL: `/releases/latest/download/...`
+
+---
+
+### Version Numbering
+
+Follows [Semantic Versioning](https://semver.org/):
+
+```
+MAJOR.MINOR.PATCH[-prerelease.number]
+  │     │     │         │
+  │     │     │         └─ Pre-release identifier (optional)
+  │     │     └─────────── Bug fixes
+  │     └────────────────── New features (backward compatible)
+  └──────────────────────── Breaking changes
+```
+
+**Examples:**
+- `1.0.0` - Stable release
+- `1.1.0-beta.1` - Beta pre-release
+- `1.1.0-beta.2` - Second beta
+- `1.1.0-rc.1` - Release candidate
+- `1.1.0` - Final stable after testing
+
 ## Development Workflow
 
 This repository contains a MediaMonkey 2024 AddOn that's distributed as an `.mmip` file via GitHub Releases. 
@@ -23,9 +109,11 @@ git push origin main
 
 ### Creating a Release
 
-When you're ready to publish a new stable version to users, you have two options:
+For information on creating releases, see the [Build and Release States](#build-and-release-states) section above.
 
-#### Option A: Using GitHub Actions (Recommended)
+When you're ready to publish a new version to users:
+
+#### Using GitHub Actions (Recommended)
 
 1. Go to the **Actions** tab in GitHub
 2. Click on the **Bump Version** workflow
@@ -34,7 +122,8 @@ When you're ready to publish a new stable version to users, you have two options
    - **patch** (`1.0.0` → `1.0.1`): Bug fixes, small tweaks
    - **minor** (`1.0.0` → `1.1.0`): New features, new scripts
    - **major** (`1.0.0` → `2.0.0`): Breaking changes, major rewrites
-5. Click **Run workflow**
+5. (Optional) Select pre-release type for beta/alpha/rc releases
+6. Click **Run workflow**
 
 **What happens automatically:**
 - Updates `version.txt` with the new version
@@ -43,15 +132,13 @@ When you're ready to publish a new stable version to users, you have two options
 - Triggers the build workflow
 - Creates a GitHub Release with the `.mmip` file
 
-#### Option B: Using Local Scripts
+#### Using Local Scripts (Alternative)
 
 If you prefer to work locally with PowerShell:
 
 ```powershell
-# 1. Bump the version
-./scripts/bump-patch.ps1    # For bug fixes
-./scripts/bump-minor.ps1    # For new features
-./scripts/bump-major.ps1    # For breaking changes
+# 1. Manually update version.txt (e.g., 1.1.0 or 1.1.0-beta.1)
+# Edit version.txt
 
 # 2. Commit the version change
 git add version.txt
@@ -67,18 +154,7 @@ git push origin main --tags
 - A new GitHub Release is automatically created
 - Release notes are auto-generated from commits
 - The `.mmip` file is attached to the release
-
-### Version Numbering (Semantic Versioning)
-
-This project follows [Semantic Versioning](https://semver.org/):
-
-```
-MAJOR.MINOR.PATCH
-  │     │     │
-  │     │     └─ Bug fixes, minor changes
-  │     └─────── New features, new scripts (backward compatible)
-  └───────────── Breaking changes, significant rewrites
-```
+- Pre-release status is detected from tag name (if it contains alpha/beta/rc)
 
 ### Download URLs