peter/spectre-meltdown-checker
1
0
Fork 0
mirror of https://github.com/speed47/spectre-meltdown-checker.git synced 2026-09-19 01:00:45 +02:00
Code Issues Projects Releases Wiki Activity

doc: update dev documentation

Browse Source
This commit is contained in:
Stéphane Lesimple
2026-09-13 11:00:38 +00:00
parent 32fa538ceb
commit 28fc991906
2 changed files with 28 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
RELEASE.md
+12 -7
View File
@@ -42,11 +42,14 @@ against the `master` branch.
### 1. `sync-from-source-build`
Copies every top-level entry on `source-build` **except `.github/`**
Opens or updates a pull request against `master` copying every top-level entry
present on `source-build` **except `.github/`**
(`spectre-meltdown-checker.sh`, `README.md`, `doc/`, `Dockerfile`,
`docker-compose.yml`) onto `master` as a single commit, mirroring exactly
(deletions and renames included). `master`'s own `.github/` — its
master-only CI — is never touched.
`docker-compose.yml`). Each selected path is mirrored exactly, including
deletions and renames within directories. Top-level entries that exist only on
`master` are left untouched. `master`'s own `.github/` — its master-only CI — is
never touched. Nothing lands on `master` until the pull request is reviewed
and merged.
The script's contents are copied byte-for-byte, so its `VERSION` (generated by
the `source-build` build) is preserved unchanged. No version bump happens here.
@@ -70,7 +73,8 @@ commit since. Treat it as a starting point and edit it before publishing.
1. Confirm `source-build` holds the artifact you want to release (CI is green,
version string looks right).
2. Run the **`release`** workflow on `master` with `action =
sync-from-source-build`. Review the resulting commit/diff on `master`.
sync-from-source-build`. Review and merge the resulting pull request into
`master`.
3. Run the **`release`** workflow on `master` with `action =
draft-github-release`.
4. Open the draft release, review/edit the auto-generated changelog, then
@@ -82,5 +86,6 @@ Steps 2 and 3 are decoupled on purpose: you can refresh `master` from
## Rollback
- Before publishing: delete the draft release in the UI (no tag exists yet).
- After a bad `sync-from-source-build`: `master` history is intact — revert the
sync commit with a normal `git revert` (never force-push `master`).
- Before merging a sync pull request: close it without merging.
- After merging a bad sync: `master` history is intact — revert the sync with
a normal `git revert` (never force-push `master`).