Skip to content

Commit c308779

Browse files
authored
Merge pull request #143 from mathstuf/tagging-rewording
Tagging rewording
2 parents df9c5e2 + f2cfcc2 commit c308779

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/documentation.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -255,23 +255,26 @@ is located at `"https://api.rocket.rs/rocket/index.html"` then the
255255
## Release notes document all significant changes (C-RELNOTES)
256256

257257
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,
259259
or the notes themselves, should be included in the crate-level documentation
260260
and/or the repository linked in Cargo.toml.
261261

262262
Breaking changes (as defined in [RFC 1105]) should be clearly identified in the
263263
release notes.
264264

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.
268268

269269
```bash
270270
# 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
272272
git push --tags
273273
```
274274

275+
Annotated tags are preferred because some Git commands ignore unannotated tags
276+
if any annotated tags exist.
277+
275278
[RFC 1105]: https://github.com/rust-lang/rfcs/blob/master/text/1105-api-evolution.md
276279

277280
### Examples

0 commit comments

Comments
 (0)