iiegn commited on
Commit
75a4475
·
1 Parent(s): a435bb8

docs: require annotated tags for framework releases

Browse files
Files changed (1) hide show
  1. RELEASE.md +6 -2
RELEASE.md CHANGED
@@ -61,6 +61,8 @@ Use [semantic versioning](https://semver.org/): `MAJOR.MINOR.PATCH`
61
 
62
  ## Release Checklist
63
 
 
 
64
  ### 1. Decide Version Number
65
 
66
  ```bash
@@ -251,7 +253,7 @@ git checkout main
251
 
252
  **Caution:** Review each branch carefully for conflicts or branch-specific issues.
253
 
254
- ### 9. Create Git Tag
255
 
256
  ```bash
257
  # Tag the main branch
@@ -269,6 +271,8 @@ See CHANGELOG.md for full details."
269
  git push origin v${NEW_VER}
270
  ```
271
 
 
 
272
  ### 10. Create GitHub Release
273
 
274
  1. Go to: https://github.com/YOUR_ORG/universal_dependencies/releases/new
@@ -475,7 +479,7 @@ git push origin v2.1.1
475
  4. **Communicate Clearly:** Explain impact to users
476
  5. **Batch Branches:** Update all UD branches together for consistency
477
  6. **Keep Changelog:** Maintain detailed CHANGELOG.md
478
- 7. **Tag Consistently:** Use `v{MAJOR}.{MINOR}.{PATCH}` format
479
 
480
  ## Troubleshooting
481
 
 
61
 
62
  ## Release Checklist
63
 
64
+ **Tagging policy:** Framework releases MUST use **annotated tags** (`git tag -a`), not lightweight tags.
65
+
66
  ### 1. Decide Version Number
67
 
68
  ```bash
 
253
 
254
  **Caution:** Review each branch carefully for conflicts or branch-specific issues.
255
 
256
+ ### 9. Create Annotated Git Tag
257
 
258
  ```bash
259
  # Tag the main branch
 
271
  git push origin v${NEW_VER}
272
  ```
273
 
274
+ Do not use lightweight tags (`git tag v${NEW_VER}`) for framework releases.
275
+
276
  ### 10. Create GitHub Release
277
 
278
  1. Go to: https://github.com/YOUR_ORG/universal_dependencies/releases/new
 
479
  4. **Communicate Clearly:** Explain impact to users
480
  5. **Batch Branches:** Update all UD branches together for consistency
481
  6. **Keep Changelog:** Maintain detailed CHANGELOG.md
482
+ 7. **Tag Consistently:** Use `v{MAJOR}.{MINOR}.{PATCH}` as annotated tags (`git tag -a`)
483
 
484
  ## Troubleshooting
485