ci: trigger releases via workflow_dispatch with version bump

Author: Максим Лясковский

.github/workflows/release.yml

@@ -1,20 +1,41 @@
 name: release
 
+# Trigger model: this workflow is triggered ONLY by manual dispatch.
+# Click "Run workflow" in the Actions tab on GitHub.com (or run
+#   `gh workflow run release.yml -f version=2.0.1`
+# from the CLI), enter the new version, and the workflow will:
+#   1. Bump version files
+#   2. Commit + tag + push to main
+#   3. Run the test suite
+#   4. Build LinkBridge.app
+#   5. Package as a zip with ditto
+#   6. Create a draft GitHub Release with auto-generated notes
 on:
-  push:
-    tags:
-      - 'v*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'New version (e.g. 2.0.1, 2.1.0). Do NOT prefix with "v".'
+        required: true
+        type: string
 
 permissions:
   contents: write
 
 jobs:
-  build-and-release:
+  release:
     runs-on: macos-latest
 
     steps:
-      - name: Checkout
+      - name: Checkout main
         uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0  # full history so auto-generated release notes can diff against the previous tag
+
+      - name: Configure git identity
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
 
       - name: Set up Python 3.11
         uses: actions/setup-python@v5
@@ -27,29 +48,39 @@ jobs:
           venv/bin/pip install --upgrade pip
           venv/bin/pip install -r requirements.txt -r requirements-dev.txt
 
-      - name: Run tests (sanity check before building)
+      - name: Run tests (sanity check)
         run: venv/bin/pytest -v
 
+      - name: Bump version files
+        run: venv/bin/bump-my-version replace --new-version "${{ inputs.version }}"
+
+      - name: Show diff after bump
+        run: git diff
+
+      - name: Commit, tag, push
+        run: |
+          git add linkbridge/__init__.py setup.py
+          git commit -m "chore: release v${{ inputs.version }}"
+          git tag -a "v${{ inputs.version }}" -m "Release v${{ inputs.version }}"
+          git push origin main
+          git push origin "v${{ inputs.version }}"
+
       - name: Build LinkBridge.app
         run: ./scripts/build_app.sh
 
       - name: Package .app as a zip with ditto
         run: |
           cd dist
-          ditto -c -k --keepParent LinkBridge.app "LinkBridge-${{ github.ref_name }}.zip"
+          ditto -c -k --keepParent LinkBridge.app "LinkBridge-v${{ inputs.version }}.zip"
           ls -la
 
       - name: Create draft GitHub Release
         env:
           GH_TOKEN: ${{ github.token }}
         run: |
-          gh release create "${{ github.ref_name }}" \
+          gh release create "v${{ inputs.version }}" \
             --repo "${{ github.repository }}" \
-            --title "LinkBridge ${{ github.ref_name }}" \
-            --notes "Automated build of ${{ github.ref_name }}.
-
-          The bundled \`.app\` is unsigned. On first launch macOS Gatekeeper will block it — right-click \`LinkBridge.app\` in Finder → **Open** → confirm the warning, then launch normally afterwards.
-
-          See the README for usage and the Rekordbox workflow notes." \
+            --title "LinkBridge v${{ inputs.version }}" \
+            --generate-notes \
             --draft \
-            "dist/LinkBridge-${{ github.ref_name }}.zip"
+            "dist/LinkBridge-v${{ inputs.version }}.zip"

README.md

@@ -201,6 +201,40 @@ clocks / fake MIDI sinks — no hardware or Link peer required. The Link
 monitor and the menu bar app are validated by manual smoke tests against
 real hardware (the smoke procedure is documented in the project plan).
 
+## Releasing a new version
+
+Releases are cut by a single click in the **GitHub Actions** tab — no local
+commands or git tagging required.
+
+1. Go to https://github.com/AnyByte/LinkBridge/actions/workflows/release.yml
+2. Click **Run workflow**
+3. Type the new version (e.g. `2.1.0`, no `v` prefix)
+4. Click **Run workflow**
+
+The CI will then:
+
+- Bump the version strings in `linkbridge/__init__.py` and `setup.py`
+- Commit and tag the bump on `main` (`v2.1.0`)
+- Run the test suite
+- Build `LinkBridge.app` and zip it via `ditto`
+- Create a **draft** GitHub Release with auto-generated notes (built from
+  the conventional-commit history since the previous tag) and the
+  `LinkBridge-v2.1.0.zip` attached
+
+Find the draft release on the
+[Releases page](https://github.com/AnyByte/LinkBridge/releases), edit the
+notes if you want, then click **Publish release**.
+
+You can also trigger the workflow from a terminal:
+
+```bash
+gh workflow run release.yml -f version=2.1.0
+gh run watch  # follow the build
+```
+
+The release workflow uses [`bump-my-version`](https://github.com/callowayproject/bump-my-version)
+under the hood; the file list is in `pyproject.toml`.
+
 ## Regenerating the app icon
 
 The icon source is `assets/icon.png` (1024×1024). To rebuild the

pyproject.toml

@@ -0,0 +1,25 @@
+# Project metadata used only by tooling — LinkBridge itself is built via setup.py + py2app.
+
+[tool.bumpversion]
+current_version = "2.0.0"
+allow_dirty = true
+commit = false
+tag = false
+sign_tags = false
+parse = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<pre>[A-Za-z0-9.]+))?'
+serialize = ["{major}.{minor}.{patch}-{pre}", "{major}.{minor}.{patch}"]
+
+[[tool.bumpversion.files]]
+filename = "linkbridge/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "setup.py"
+search = '"CFBundleVersion": "{current_version}"'
+replace = '"CFBundleVersion": "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "setup.py"
+search = '"CFBundleShortVersionString": "{current_version}"'
+replace = '"CFBundleShortVersionString": "{new_version}"'

requirements-dev.txt

@@ -1,2 +1,3 @@
+bump-my-version==1.3.0
 py2app==0.28.10
 pytest==9.0.3