Skip to content

Commit 148ddb3

Browse files
committed
Didn't like the auto-release flow, removed that kept linting and test runs
1 parent ef3e644 commit 148ddb3

4 files changed

Lines changed: 14 additions & 119 deletions

File tree

.github/workflows/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This directory contains automated CI/CD workflows for MechBay.
1515
- Verifies app initialization
1616

1717
### `release.yml` - Build and Release
18-
**Triggers**: GitHub release creation or version tag push (e.g., `v0.1.1`)
18+
**Triggers**: Manual GitHub release creation only
1919

2020
**Purpose**: Builds Windows executable and attaches to release
2121

@@ -25,25 +25,23 @@ This directory contains automated CI/CD workflows for MechBay.
2525
- Uploads ZIP file to GitHub release
2626
- Stores artifacts for 30 days
2727

28-
### `auto-release.yml` - Automatic Release
29-
**Triggers**: Push to `main` with version bump in `pyproject.toml`
30-
31-
**Purpose**: Automates release creation when version changes
32-
33-
**Actions**:
34-
- Detects version changes in `pyproject.toml`
35-
- Creates GitHub release with tag
36-
- Triggers `release.yml` workflow to build executable
37-
3828
## Quick Release Guide
3929

40-
**Easiest method (auto-release):**
30+
**Release process:**
4131
```powershell
32+
# 1. Bump version locally
4233
uv version --bump patch
34+
35+
# 2. Commit and push
4336
git add pyproject.toml
44-
git commit -m "Release v0.1.x"
37+
git commit -m "Bump version to 0.1.x"
4538
git push
39+
40+
# 3. Create release on GitHub.com
41+
# Go to Releases → Draft a new release
42+
# Create tag matching version (e.g., v0.1.1)
43+
# Click "Publish release"
44+
# GitHub Actions automatically builds and uploads ZIP
4645
```
47-
GitHub Actions automatically creates release and builds executable.
4846

4947
**See [DEVELOPER.md](../Docs/DEVELOPER.md#continuous-integration--deployment) for detailed instructions.**

.github/workflows/auto-release.yml

Lines changed: 0 additions & 56 deletions
This file was deleted.

.github/workflows/release.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ name: Release - Build and Publish
33
on:
44
release:
55
types: [created]
6-
push:
7-
tags:
8-
- "v*.*.*"
96

107
jobs:
118
build-windows:

Docs/DEVELOPER.md

Lines changed: 2 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -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**:
321321
1. Sets up Python 3.13 and UV environment
@@ -327,20 +327,9 @@ This ensures code quality and prevents regressions from being merged.
327327
7. Uploads ZIP to GitHub release as downloadable asset
328328
8. 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

393354
After 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

Comments
 (0)