Skip to content

Commit 716d800

Browse files
committed
Fix race condition in release instructions
1 parent cf3012c commit 716d800

1 file changed

Lines changed: 20 additions & 19 deletions

File tree

DEPLOY.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,13 @@ This is the release flow for `bitloops/local-dashboard` bundle artifacts consume
1212
- Version discovery is static:
1313
- `https://raw.githubusercontent.com/bitloops/local-dashboard/main/bundle_versions.json`
1414

15-
## 1. Open One Release PR (`vX.Y.Z`)
16-
17-
Single PR is enough.
15+
## 1. Open Release PR for Version Bump (`vX.Y.Z`)
1816

1917
Include:
2018

2119
- `package.json` version bump to `X.Y.Z`
22-
- `bundle_versions.json` new entry for `X.Y.Z`
2320

24-
Example manifest entry:
25-
26-
```json
27-
{
28-
"version": "X.Y.Z",
29-
"min_required_cli_version": "A.B.C",
30-
"max_required_cli_version": "latest",
31-
"download_url": "https://github.com/bitloops/local-dashboard/releases/download/vX.Y.Z/bundle.tar.zst",
32-
"checksum_url": "https://github.com/bitloops/local-dashboard/releases/download/vX.Y.Z/bundle.tar.zst.sha256"
33-
}
34-
```
35-
36-
Then merge the PR after CI passes.
21+
Merge the PR after CI passes. **Do not include `bundle_versions.json` yet.**
3722

3823
## 2. Create and Push Tag
3924

@@ -61,13 +46,29 @@ Success criteria:
6146

6247
Confirm you can download, verify checksum, extract, and render `index.html`.
6348

64-
## 5. Why `version.json` Exists
49+
## 5. Update Bundle Versions
50+
51+
After release is confirmed working, open a PR to add the new entry to `bundle_versions.json`:
52+
53+
```json
54+
{
55+
"version": "X.Y.Z",
56+
"min_required_cli_version": "A.B.C",
57+
"max_required_cli_version": "latest",
58+
"download_url": "https://github.com/bitloops/local-dashboard/releases/download/vX.Y.Z/bundle.tar.zst",
59+
"checksum_url": "https://github.com/bitloops/local-dashboard/releases/download/vX.Y.Z/bundle.tar.zst.sha256"
60+
}
61+
```
62+
63+
Merge after CI passes. This ensures `bundle_versions.json` only references assets that exist.
64+
65+
## 6. Why `version.json` Exists
6566

6667
`~/.bitloops/dashboard/bundle/version.json` is used by the CLI to know which dashboard version is installed and whether updates are available.
6768

6869
You do **not** edit this file manually. The release workflow generates it inside the bundle archive from the release tag/version.
6970

70-
## 6. Rollback
71+
## 7. Rollback
7172

7273
If release `vX.Y.Z` is bad:
7374

0 commit comments

Comments
 (0)