Skip to content

Commit 501f093

Browse files
meizhong986meizhong986
committed
bump to release 1.8.13
1 parent cb9d8c3 commit 501f093

3 files changed

Lines changed: 242 additions & 4 deletions

File tree

‎docs/release_v1.8.13_step6_guide.md‎

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
# v1.8.13 Step 6 Manual Release Guide
2+
3+
> **You are here:** code committed (4 commits on `dev_v1.8.13`), version
4+
> bumped to 1.8.13 (`installer/VERSION`), installer files regenerated
5+
> (`installer/generated/`), wheel built, .exe built. This guide walks
6+
> you through the final manual steps: merge, tag, push, publish.
7+
8+
---
9+
10+
## Pre-flight checklist
11+
12+
Before doing anything destructive, verify the local state is what you expect:
13+
14+
```powershell
15+
# Working tree clean?
16+
git status # → "nothing to commit, working tree clean"
17+
18+
# Right branch + ahead of main as expected?
19+
git rev-parse --abbrev-ref HEAD # → dev_v1.8.13
20+
git log --oneline main..HEAD | wc -l # → ~27 (28 after VERSION commit, see below)
21+
22+
# The 4 fix commits from this session present?
23+
git log --oneline -5 # → cb9d8c3 docs..., 745f970 tools..., 42e7415 feat(main)..., ad22a6e fix(asr)...
24+
25+
# Wheel + .exe built?
26+
ls installer/generated/whisperjav-1.8.13-py3-none-any.whl
27+
ls installer/generated/WhisperJAV-1.8.13-Windows-x86_64.exe
28+
```
29+
30+
If any of these fail, **stop** and reconcile before proceeding.
31+
32+
---
33+
34+
## Step 6.0 — Commit the version bump (if not already)
35+
36+
The `installer/VERSION` change (1.8.12 → 1.8.13) was made but not yet
37+
committed. Commit it as the final pre-tag commit:
38+
39+
```powershell
40+
git add installer/VERSION
41+
git commit -m @'
42+
chore(release): bump version 1.8.12 → 1.8.13
43+
44+
Triggers build_release.py to regenerate all 11 templated installer
45+
files at installer/generated/, builds whisperjav-1.8.13-py3-none-any.whl
46+
wheel, and produces WhisperJAV-1.8.13-Windows-x86_64.exe via
47+
conda-constructor.
48+
49+
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
50+
'@
51+
```
52+
53+
---
54+
55+
## Step 6.1 — Merge `dev_v1.8.13` → `main`
56+
57+
Two merge options. Pick whichever your repo convention prefers:
58+
59+
### Option A — Merge commit (preserves dev_v1.8.13 history)
60+
61+
```powershell
62+
git checkout main
63+
git pull --ff-only origin main # safety: ensure local main is up to date
64+
git merge --no-ff dev_v1.8.13 -m @'
65+
Merge branch 'dev_v1.8.13' for v1.8.13 release
66+
67+
v1.8.13 — Polish + WhisperSeg Default (Ensemble/Qwen/Decoupled) + Model Default Revert
68+
69+
Headline changes:
70+
- Default Whisper model reverted from large-v3 to large-v2
71+
(BalancedPipeline + Stable-TS backends; OpenAI-Whisper already on v2).
72+
Empirical regression: F4/F6/F7 acceptance testing showed 6-10/68 GT
73+
entries with v3 vs 51/68 with v2 on JAV reference clip.
74+
v1.9.x will re-tune for v3.
75+
76+
- WhisperSeg becomes default for Ensemble Mode, Qwen pipeline, and
77+
Decoupled pipeline. Simple Transcription Mode keeps silero-v3.1
78+
pending v1.9.0 unified segmenter param routing fix.
79+
80+
- main.py adds explicit allow-list of "safe paths" for non-Silero
81+
segmenter defaults; warns + downgrades on explicit non-Silero
82+
override in unsafe simple-mode paths.
83+
84+
Polish: --ollama-num-ctx flag (#271), French target + English source
85+
languages (#308), --dump-params runtime mirror (#312), Linux uv install
86+
fix (#300, #313), Models & Cache FAQ (#99, #250, #264), efwkjn/whisper-
87+
ja-anime-v0.3 selectable (#232), assorted GUI/qwen/decoupled bug fixes.
88+
89+
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
90+
'@
91+
```
92+
93+
### Option B — Fast-forward (only if main has no commits ahead of where dev_v1.8.13 diverged)
94+
95+
```powershell
96+
git checkout main
97+
git pull --ff-only origin main
98+
git merge --ff-only dev_v1.8.13
99+
```
100+
101+
If `--ff-only` errors, main has commits dev_v1.8.13 doesn't. Use Option A.
102+
103+
---
104+
105+
## Step 6.2 — Tag the release
106+
107+
```powershell
108+
git tag -a v1.8.13 -m @'
109+
WhisperJAV v1.8.13
110+
111+
Polish + WhisperSeg Default (Ensemble/Qwen/Decoupled) + Model Default
112+
Revert (large-v3 → large-v2 due to v1.8.12 ASR preset interaction).
113+
114+
See docs/release_notes_v1.8.13.md for full details.
115+
'@
116+
117+
# Verify the tag
118+
git show v1.8.13 --stat | head -20
119+
```
120+
121+
---
122+
123+
## Step 6.3 — Push to GitHub
124+
125+
```powershell
126+
# Push main with tag in one step
127+
git push origin main --follow-tags
128+
129+
# OR if you prefer separately:
130+
git push origin main
131+
git push origin v1.8.13
132+
```
133+
134+
If `git push` fails due to upstream protection rules, push `dev_v1.8.13`
135+
first and let the merge happen via PR:
136+
137+
```powershell
138+
git push origin dev_v1.8.13
139+
# Then open a PR from dev_v1.8.13 → main on github.com
140+
```
141+
142+
---
143+
144+
## Step 6.4 — Publish GitHub Release
145+
146+
1. Go to: https://github.com/meizhong986/whisperjav/releases/new
147+
148+
2. Fill in:
149+
- **Tag**: `v1.8.13` (select the tag you just pushed)
150+
- **Target**: `main`
151+
- **Title**: `WhisperJAV v1.8.13 — Polish + Model Default Revert`
152+
- **Description**: paste the body of `docs/release_notes_v1.8.13.md`
153+
(omit the `> Draft — to be finalized before tag.` line)
154+
155+
3. **Attach binaries** (drag-drop into the release):
156+
- `installer/generated/WhisperJAV-1.8.13-Windows-x86_64.exe`
157+
- (Optional but useful) `installer/generated/whisperjav-1.8.13-py3-none-any.whl`
158+
159+
4. **CRITICAL — Pre-release checkbox:**
160+
- **☐ Set as a pre-release** ← **LEAVE UNCHECKED**
161+
- This is a stable release. Per CLAUDE.md / repo memory:
162+
- Unchecked → all users get upgrade notification via the GUI's
163+
UpdateCheckManager (which queries `/releases/latest`)
164+
- Checked → ONLY testers who manually visit Releases page see it
165+
- Misclicking this is the #1 release-day mistake.
166+
167+
5. **☐ Set as the latest release** — leave checked (default behavior).
168+
169+
6. **Publish release** (the green button).
170+
171+
---
172+
173+
## Step 6.5 — Post-release smoke checks (recommended, ~10 min)
174+
175+
Once the release is live:
176+
177+
```powershell
178+
# Test the upgrade prompt fires (pretend you're an old user):
179+
# 1. Launch a v1.8.12 install of WhisperJAV
180+
# 2. GUI's "Check for updates" should now offer v1.8.13
181+
# 3. Verify the .exe downloads + installs cleanly
182+
```
183+
184+
Or simply visit the release page and confirm:
185+
- The .exe is downloadable
186+
- File size is ~150MB (constructor builds)
187+
- The release does NOT have a "Pre-release" tag in the UI
188+
189+
---
190+
191+
## Step 6.6 — Post-release replies
192+
193+
Per the resume pointer: 6 prepared replies in
194+
`docs/release_v1.8.13_reply_drafts.md` should be posted to the relevant
195+
GitHub issues after the release publishes. Open each linked issue and
196+
paste the corresponding draft.
197+
198+
---
199+
200+
## Step 6.7 — Tracker update
201+
202+
After everything is live, add a tracker entry to
203+
`docs/ISSUE_TRACKER_v1.8.x.md` (rev49) documenting:
204+
- v1.8.13 shipped
205+
- Headline changes (model revert, WhisperSeg scope)
206+
- Open follow-ups for v1.9.x (re-tune for large-v3, unified segmenter
207+
param routing)
208+
209+
---
210+
211+
## If something goes wrong
212+
213+
| Symptom | Action |
214+
|---|---|
215+
| `git push` rejected | Pull first: `git pull --rebase origin main` |
216+
| Wrong tag pushed | `git tag -d v1.8.13 && git push origin :refs/tags/v1.8.13`, then re-tag and push |
217+
| Pre-release checkbox accidentally checked | Edit the release on GitHub → uncheck → save (users will get the notification on the next /releases/latest poll) |
218+
| .exe upload fails (size > 2GB) | This shouldn't happen (~150MB) but if it does, host externally and link in the release notes |
219+
| Pre-flight checklist fails | Don't proceed. Re-run `git status`, verify the 4 fix commits, verify the wheel + .exe exist. If anything is wrong, ask Claude to investigate before continuing |
220+
221+
---
222+
223+
## Reference: what was committed in this release session
224+
225+
```
226+
cb9d8c3 docs: v1.8.13 release notes — model revert + scoped WhisperSeg default
227+
745f970 tools(fw-diag): add G_PROD_CL30 + H_PROD_NOCL chunk_length isolation variants
228+
42e7415 feat(main): scope v1.8.13 segmenter default flip to safe paths
229+
ad22a6e fix(asr): revert default Whisper model large-v3 → large-v2 (regression)
230+
```
231+
232+
Plus the version-bump commit (Step 6.0 above) makes 5 new commits for
233+
v1.8.13.
234+
235+
Test artifacts referenced in commit messages:
236+
- `test_media/1813 acceptance/F4/` (catastrophic baseline, large-v3)
237+
- `test_media/1813 acceptance/F4/DIAG_FW/chunk_length_test/` (G_PROD_CL30 vs H_PROD_NOCL)
238+
- `test_media/1813 acceptance/F8/` (verified fix, large-v2, 51/68 entries)

‎installer/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[version]
77
major = 1
88
minor = 8
9-
patch = 12
9+
patch = 13
1010
# PEP 440 prerelease suffix for wheel/pip (a0, b0, rc0, .post1, or empty for stable)
1111
prerelease =
1212
# Human-readable label for display (alpha, beta, rc, hotfix1, or empty for clean version)

‎whisperjav/__version__.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
"""Version information for WhisperJAV."""
33

44
# PEP 440 compliant version for pip/wheel
5-
__version__ = "1.8.12"
5+
__version__ = "1.8.13"
66

77
# Human-readable version for display in UI
8-
__version_display__ = "1.8.12"
8+
__version_display__ = "1.8.13"
99

1010
# Version metadata
1111
__version_info__ = {
1212
"major": 1,
1313
"minor": 8,
14-
"patch": 12,
14+
"patch": 13,
1515
"release": "",
1616
"architecture": "v4.4"
1717
}

0 commit comments

Comments
 (0)