File tree Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -255,23 +255,26 @@ is located at `"https://api.rocket.rs/rocket/index.html"` then the
255
255
## Release notes document all significant changes (C-RELNOTES)
256
256
257
257
Users of the crate can read the release notes to find a summary of what
258
- changed in each published release of the crate. A link to the release notes,
258
+ changed in each published release of the crate. A link to the release notes,
259
259
or the notes themselves, should be included in the crate-level documentation
260
260
and/or the repository linked in Cargo.toml.
261
261
262
262
Breaking changes (as defined in [ RFC 1105] ) should be clearly identified in the
263
263
release notes.
264
264
265
- If using git to track the source of a crate, every release published to
266
- * crates.io* should have a corresponding git tag identifying the commit that was
267
- published. A similar process should exist for non-git VCS tools as well.
265
+ If using Git to track the source of a crate, every release published to
266
+ * crates.io* should have a corresponding tag identifying the commit that was
267
+ published. A similar process should be used for non-Git VCS tools as well.
268
268
269
269
``` bash
270
270
# Tag the current commit
271
- GIT_COMMITTER_DATE=$( git show --format =%aD | head -1 ) git tag -a -m " Release 0.3.0" 0.3.0
271
+ GIT_COMMITTER_DATE=$( git log -n1 --pretty =%aD) git tag -a -m " Release 0.3.0" 0.3.0
272
272
git push --tags
273
273
```
274
274
275
+ Annotated tags are preferred because some Git commands ignore unannotated tags
276
+ if any annotated tags exist.
277
+
275
278
[ RFC 1105 ] : https://github.com/rust-lang/rfcs/blob/master/text/1105-api-evolution.md
276
279
277
280
### Examples
You can’t perform that action at this time.
0 commit comments