Skip to content

Commit 84fa36f

Browse files
authored
Clarify remote vs fork in release checklist (#284)
1 parent 78300f3 commit 84fa36f

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/release-checklist.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,20 @@ This document provides a comprehensive checklist for creating a new release of d
2626
7. **Pull the latest main branch locally**:
2727
```bash
2828
git checkout main
29-
git pull origin main
29+
git pull upstream main
3030
```
3131

3232
## Release Process
3333

3434
8. **Ensure all CI tests are passing** on the main branch - check https://github.com/dn-vm/dnvm/actions
3535

36-
9. **Create and push a git tag** for the new version:
36+
9. **Create and push a git tag** for the new version to the upstream repository:
3737
```bash
3838
git tag vX.Y.Z
39-
git push origin vX.Y.Z
39+
git push upstream vX.Y.Z
4040
```
41+
42+
**Note**: Make sure to push the tag to `upstream` (dn-vm/dnvm), not your personal fork.
4143

4244
10. **Wait for the GitHub Actions workflow to complete** - The `publish.yml` workflow will automatically:
4345
- Build for all platforms (linux-x64, linux-arm64, win-x64, osx-x64, osx-arm64)
@@ -71,11 +73,12 @@ This document provides a comprehensive checklist for creating a new release of d
7173

7274
## Notes
7375

74-
- The publish workflow is triggered by pushing a tag starting with `v` (e.g., `v0.9.9`)
76+
- The publish workflow is triggered by pushing a tag starting with `v` (e.g., `v0.9.9`) to the **upstream** repository (dn-vm/dnvm)
7577
- Releases are created as drafts automatically, allowing for review before publishing
7678
- The workflow handles signing with the private key stored in GitHub secrets
7779
- Cross-compilation for ARM64 Linux is handled automatically in the workflow
7880
- **Important**: Tags should only be created from the `main` branch after the version bump PR is merged
81+
- **Important**: Tags must be pushed to `upstream` (dn-vm/dnvm), not to a personal fork
7982

8083
## Version Numbering
8184

0 commit comments

Comments
 (0)