Skip to content

Commit fa8d698

Browse files
authored
Merge pull request #315 from DataDog/sameerank/improve-lerna-release-docs
docs: require merge-commit for release PRs
2 parents c641a92 + b469337 commit fa8d698

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,13 @@ All packages are published with the `latest` npm tag.
152152
- Same as above, but uses `--force-publish` to prompt for **all** packages
153153
- Use this when you want to release all packages together with the same version
154154

155-
#### Step 4: Publish via GitHub Release
155+
#### Step 4: Open and Merge the Release PR
156+
157+
4. **Open a PR from your release branch and merge it with a merge commit — not a squash.**
158+
159+
`yarn release` pushes the version tag onto your branch commit. Squashing creates a new commit on `main` and orphans that tag, which breaks change detection on the _next_ release (Lerna falls back to an old tag and prompts to version packages that never changed). A merge commit keeps the tag reachable.
160+
161+
#### Step 5: Publish via GitHub Release
156162

157163
**Publishing is fully automated via GitHub workflows!**
158164

0 commit comments

Comments
 (0)