chore: automatic semantic versioning with nyx

Author: fabb

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request: # Run on pull requests
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Run tests
+        run: ./gradlew test
+
+      - name: Build extension
+        run: ./gradlew bwextension
+
+      - name: Upload extension artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: WigAI.bwextension-pr-${{ github.event.number || github.sha }}
+          path: build/extensions/WigAI.bwextension
+          retention-days: 7

.github/workflows/release.yml

@@ -1,21 +1,26 @@
 name: Release Extension
 
 on:
-  workflow_dispatch: # Allows manual triggering
-  pull_request: # Run on pull requests
-#   push:
-#     branches:
-#       - main # Triggers on pushes to the main branch
+  push:
+    branches: [main]  # Automatic releases on main branch
+  workflow_dispatch:  # Manual triggering
 
 permissions:
   contents: write
+  issues: write
+  pull-requests: write
+  actions: write
+  packages: write
 
 jobs:
-  build:
+  release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for Nyx
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set up JDK 21
         uses: actions/setup-java@v4
@@ -26,53 +31,19 @@ jobs:
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@v4
 
-      - name: Build extension
-        run: ./gradlew bwextension
+      - name: Run tests
+        run: ./gradlew test
 
-      - name: Upload extension artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: WigAI.bwextension
-          path: build/extensions/WigAI.bwextension
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
 
-  release:
-    runs-on: ubuntu-latest
-    needs: build
-    if: github.event_name == 'workflow_dispatch'
-    # || (github.event_name == 'push' && github.ref == 'refs/heads/main')
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Fetch all history for changelog generation
-
-      - name: Download extension artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: WigAI.bwextension
-          path: . # Download directly into the current workspace directory
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-
-      - name: Install conventional-changelog-cli
-        run: npm install -g conventional-changelog-cli conventional-commits-parser
-
-      - name: Generate release notes
-        run: conventional-changelog -p angular -i CHANGELOG.md -s -r 0 > RELEASE_NOTES.md && cat RELEASE_NOTES.md
-
-      - name: Generate tag name
-        id: generate_tag # id is not strictly needed here as we are using GITHUB_ENV but good practice
-        run: echo "TAG_NAME=release-$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV
+      - name: Build extension with updated version
+        run: ./gradlew bwextension
 
-      - name: Create GitHub Release
-        uses: softprops/action-gh-release@v1
-        with:
-          tag_name: ${{ env.TAG_NAME }}
-          name: Release ${{ env.TAG_NAME }}
-          body_path: RELEASE_NOTES.md
-          files: WigAI.bwextension # Updated path
+      - name: Nyx publish release with assets
+        run: ./gradlew nyxPublish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -34,3 +34,8 @@ hs_err_pid*
 
 # Logs
 *.log
+
+# Nyx
+.nyx/
+
+CHANGELOG.md

README.md

@@ -43,6 +43,17 @@ Once the extension is activated in Bitwig Studio, the MCP server will be availab
 
 This project is developed using the [BMAD v2 method](https://github.com/bmadcode/BMAD-METHOD) with AI Agents. The files in folders `agents`, `ai` and `docs` used for this development method.
 
+## Releases
+
+This project uses [Nyx](https://github.com/mooltiverse/nyx) for semantic versioning and automated releases. The release process follows [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+- `feat:` - new features (minor version bump)
+- `fix:` - bug fixes (patch version bump)
+- `feat!:` or `BREAKING CHANGE:` - breaking changes (major version bump)
+- `chore:`, `docs:`, `style:`, `refactor:`, `test:` - no version bump
+
+Releases are automatically created on pushes to the `main` branch when commits follow the conventional commit format.
+
 ## License
 
 [MIT License](LICENSE)

build.gradle.kts

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = "io.github.fabb"
-version = "0.2.0"
+// Version is managed by Nyx - it will be set automatically by the Nyx plugin
 
 repositories {
     mavenCentral()

docs/semantic-versioning-guide.md

@@ -0,0 +1,113 @@
+# Semantic Versioning Guide for WigAI
+
+This project uses [Semantic Versioning](https://semver.org/) with automated releases based on conventional commits.
+
+## Commit Message Format
+
+Use the [Conventional Commits](https://conventionalcommits.org/) specification:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+## Commit Types and Version Impact
+
+### PATCH Releases (0.2.0 → 0.2.1)
+Bug fixes that don't break existing functionality:
+
+```bash
+git commit -m "fix: resolve null pointer exception in device controller"
+git commit -m "fix(mcp): handle connection timeout gracefully"
+git commit -m "fix(transport): correct play/pause state synchronization"
+```
+
+### MINOR Releases (0.2.0 → 0.3.0)
+New features that are backward compatible:
+
+```bash
+git commit -m "feat: add support for scene banking operations"
+git commit -m "feat(mcp): implement new device parameter tool"
+git commit -m "feat(ui): add configuration panel for MCP settings"
+```
+
+### MAJOR Releases (0.2.0 → 1.0.0)
+Breaking changes that require user intervention:
+
+```bash
+git commit -m "feat!: redesign MCP tool interface for better performance"
+
+# Or with explicit breaking change footer:
+git commit -m "feat: change device API structure
+
+BREAKING CHANGE: Device.getParameter() now returns Optional<Parameter> instead of Parameter"
+```
+
+## Common Commit Types
+
+- `fix:` - Bug fixes
+- `feat:` - New features
+- `docs:` - Documentation changes
+- `style:` - Code style changes (formatting, etc.)
+- `refactor:` - Code refactoring without feature changes
+- `test:` - Adding or updating tests
+- `chore:` - Maintenance tasks, dependency updates
+- `perf:` - Performance improvements
+- `ci:` - CI/CD configuration changes
+
+## Scopes (Optional)
+
+Use scopes to indicate the area of change:
+
+- `mcp` - MCP server related changes
+- `transport` - Transport control functionality
+- `device` - Device parameter management
+- `clip` - Clip and scene management
+- `config` - Configuration management
+- `ui` - User interface changes
+- `api` - API changes
+
+## Examples for WigAI
+
+```bash
+# Bug fixes (PATCH)
+git commit -m "fix(mcp): resolve server startup race condition"
+git commit -m "fix(device): handle missing parameter gracefully"
+
+# New features (MINOR)
+git commit -m "feat(transport): add support for tempo changes"
+git commit -m "feat(mcp): implement clip launch tool"
+
+# Breaking changes (MAJOR)
+git commit -m "feat(api)!: change MCP tool response format"
+git commit -m "feat: restructure extension initialization
+
+BREAKING CHANGE: WigAIExtension constructor now requires McpServerManager parameter"
+```
+
+## Release Process
+
+1. **Push to main branch** - Triggers automatic analysis
+2. **Semantic Release analyzes commits** - Determines version bump type
+3. **Version update** - Updates `build.gradle.kts` automatically
+4. **Changelog generation** - Updates `CHANGELOG.md`
+5. **GitHub release** - Creates release with artifacts
+6. **Git tag** - Tags the release (e.g., `v0.3.0`)
+
+## No Release Scenarios
+
+These commit types will NOT trigger a release:
+
+```bash
+git commit -m "docs: update README with new features"
+git commit -m "style: fix code formatting"
+git commit -m "ci: update GitHub Actions workflow"
+git commit -m "chore: update dependencies"
+```
+
+## Manual Release
+
+If needed, you can manually trigger a release using GitHub Actions workflow dispatch, but it's recommended to use the commit-based approach for consistency.

settings.gradle.kts

@@ -1 +1,35 @@
+plugins {
+    id("com.mooltiverse.oss.nyx") version "3.1.3"
+}
+
 rootProject.name = "wigai"
+
+// Nyx configuration for semantic versioning and releases
+configure<com.mooltiverse.oss.nyx.gradle.NyxExtension> {
+    preset.set("extended")
+
+    services {
+        register("github") {
+            type.set("GITHUB")
+            options.set(mapOf(
+                "AUTHENTICATION_TOKEN" to "{{#environmentVariable}}GITHUB_TOKEN{{/environmentVariable}}",
+                "REPOSITORY_OWNER" to "fabb",
+                "REPOSITORY_NAME" to "WigAI",
+            ))
+        }
+    }
+
+    releaseTypes {
+        publicationServices.set(listOf("github"))
+    }
+
+    // Release assets to upload
+    releaseAssets {
+        register("wigaiExtension") {
+            fileName.set("WigAI.bwextension")
+            description.set("WigAI Bitwig Extension for version {{version}}")
+            type.set("application/java-archive")
+            path.set("build/extensions/WigAI.bwextension")
+        }
+    }
+}