@@ -315,7 +315,7 @@ This ensures code quality and prevents regressions from being merged.
315315
316316### Release Workflow (` .github/workflows/release.yml ` )
317317
318- ** Triggers** : Creating a GitHub release or pushing a version tag (e.g., ` v0.1.1 ` )
318+ ** Triggers** : Manually creating a GitHub release
319319
320320** Actions** :
3213211 . Sets up Python 3.13 and UV environment
@@ -327,20 +327,9 @@ This ensures code quality and prevents regressions from being merged.
3273277 . Uploads ZIP to GitHub release as downloadable asset
3283288 . Stores build artifacts for 30 days
329329
330- ### Auto-Release Workflow (` .github/workflows/auto-release.yml ` )
331-
332- ** Triggers** : Push to ` main ` branch with changes to ` pyproject.toml ` version field
333-
334- ** Actions** :
335- - Detects version bump in ` pyproject.toml `
336- - Automatically creates GitHub release with version tag
337- - Release workflow then triggers to build and attach executable
338-
339- This enables a streamlined release process: just bump version and push to main.
340-
341330### Creating a Release
342331
343- ** Option 1: Manual GitHub Release (Recommended) **
332+ ** Recommended workflow: **
344333
345334``` powershell
346335# Bump version locally
@@ -360,34 +349,6 @@ git push
360349# GitHub Actions automatically builds and attaches Windows ZIP
361350```
362351
363- ** Option 2: Tag-Based Release**
364-
365- ``` powershell
366- # Bump version and create tag in one workflow
367- uv version --bump patch
368- $version = (Select-String -Path pyproject.toml -Pattern 'version = ""(.+)""' | ForEach-Object { $_.Matches.Groups[1].Value })
369-
370- git add pyproject.toml
371- git commit -m "Bump version to $version"
372- git tag -a "v$version" -m "Release v$version"
373- git push origin main --tags
374-
375- # GitHub Actions detects tag and builds release automatically
376- ```
377-
378- ** Option 3: Auto-Release (Simplest)**
379-
380- ``` powershell
381- # Just bump version and push to main
382- uv version --bump patch
383- git add pyproject.toml
384- git commit -m "Bump version to $(Select-String -Path pyproject.toml -Pattern 'version = ""(.+)""' | ForEach-Object { $_.Matches.Groups[1].Value })"
385- git push
386-
387- # Auto-release workflow creates tag and release automatically
388- # Release workflow then builds and attaches executable
389- ```
390-
391352### Distributing to Users
392353
393354After release is published with attached ZIP:
@@ -415,11 +376,6 @@ After release is published with attached ZIP:
415376- Check that all dependencies are in ` pyproject.toml `
416377- Test local build with ` uv run pyinstaller mechbay.spec `
417378
418- ** Auto-release not triggering:**
419- - Ensure ` pyproject.toml ` version field actually changed
420- - Check that push was to ` main ` branch
421- - Verify ` .github/workflows/auto-release.yml ` exists and is enabled
422-
423379## Code Quality
424380
425381### Linting
0 commit comments