Skip to content

Commit a35204f

Browse files
committed
docs(release-check): require creating a GitHub Release, not just a tag
A pushed git tag does not create a GitHub Release; the repo landing page shows the latest Release, so v0.2.1 still displayed as v0.2.0 until 'gh release create' was run. Add step 11 and a pitfall to make release publication explicit.
1 parent ae6a849 commit a35204f

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

.github/skills/release-check/SKILL.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,28 @@ Everything regenerated in steps 2 and 6 must be staged (or intentionally exclude
8080
### 10. Summary report
8181
Print a markdown table with one row per step (PASS / FAIL / SKIPPED + note). Do NOT run `git push` automatically — surface the table and let the user push.
8282

83+
### 11. Publish the release on GitHub (tag is NOT enough)
84+
85+
A pushed git tag does **not** create a GitHub Release, and the repo's landing page / "Releases" sidebar shows the latest **Release**, not the latest tag. If you stop at `git push origin vX.Y.Z`, GitHub will keep displaying the previous version.
86+
87+
After the tag is pushed, always create the matching Release:
88+
89+
```bash
90+
# Verify what GitHub currently shows as "Latest"
91+
gh release list --limit 5
92+
93+
# Create the Release for the new tag, with notes from the NEWS.md section
94+
gh release create vX.Y.Z --title "ensembleHTE X.Y.Z" --notes "<paste the NEWS.md X.Y.Z bullets>"
95+
96+
# Confirm the new version is now marked "Latest"
97+
gh release list --limit 5
98+
```
99+
100+
The release is only complete when `gh release list` shows the new version tagged `Latest`. `gh` is authenticated on this machine (`gh auth status`); if it is not, tell the user to run `gh auth login` themselves — never do it silently.
101+
83102
## Pitfalls
84103

104+
- Pushing a git tag is NOT a release. The GitHub landing page shows the latest **GitHub Release**, so you must run `gh release create vX.Y.Z` (step 11) or the site keeps showing the old version. Verify with `gh release list` that the new version is `Latest`.
85105
- Running `devtools::test()` without `NOT_CRAN=true` skips the heavy tests that exercise `grf` and ensemble paths.
86106
- Forgetting to re-run `precompute_vignette_fits.R` after an API change → vignettes break on the next pkgdown build.
87107
- Staging `man/*.Rd` edits without re-running `devtools::document()` produces a doc/code mismatch.

0 commit comments

Comments
 (0)