Skip to content

Commit

Permalink
doc(yank): mention [email protected] and revoking creds
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Mar 23, 2023
1 parent cf53de8 commit e908f6a
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/doc/man/cargo-yank.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,16 @@ A common workflow is to yank a crate having already published a semver
compatible version, to reduce the probability of preventing dependent
crates from compiling.

To address copyright, licensing, or personal data issues with your published
crate, contact the maintainers of the registry you used. For crates.io, refer
to their [policies] and contact them at <[email protected]>.

If your credentials have been leaked, the recommended process is to revoke them
immediately. Once a crate is published, it's impossible to know if those leaked
credentials have been copied, so taking swift action is crucial.

[RustSec]: https://rustsec.org/
[policies]: https://crates.io/policies

## OPTIONS

Expand Down
10 changes: 10 additions & 0 deletions src/doc/man/generated_txt/cargo-yank.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ DESCRIPTION
compatible version, to reduce the probability of preventing dependent
crates from compiling.

To address copyright, licensing, or personal data issues with your
published crate, contact the maintainers of the registry you used. For
crates.io, refer to their policies <https://crates.io/policies> and
contact them at <[email protected]>.

If your credentials have been leaked, the recommended process is to
revoke them immediately. Once a crate is published, it’s impossible to
know if those leaked credentials have been copied, so taking swift
action is crucial.

OPTIONS
Yank Options
--vers version, --version version
Expand Down
9 changes: 9 additions & 0 deletions src/doc/src/commands/cargo-yank.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,16 @@ A common workflow is to yank a crate having already published a semver
compatible version, to reduce the probability of preventing dependent
crates from compiling.

To address copyright, licensing, or personal data issues with your published
crate, contact the maintainers of the registry you used. For crates.io, refer
to their [policies] and contact them at <[email protected]>.

If your credentials have been leaked, the recommended process is to revoke them
immediately. Once a crate is published, it's impossible to know if those leaked
credentials have been copied, so taking swift action is crucial.

[RustSec]: https://rustsec.org/
[policies]: https://crates.io/policies

## OPTIONS

Expand Down
8 changes: 8 additions & 0 deletions src/etc/man/cargo-yank.1
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ irrespective of susceptibility to the vulnerability in question.
A common workflow is to yank a crate having already published a semver
compatible version, to reduce the probability of preventing dependent
crates from compiling.
.sp
To address copyright, licensing, or personal data issues with your published
crate, contact the maintainers of the registry you used. For crates.io, refer
to their \fIpolicies\fR <https://crates.io/policies> and contact them at <[email protected]>\&.
.sp
If your credentials have been leaked, the recommended process is to revoke them
immediately. Once a crate is published, it\[cq]s impossible to know if those leaked
credentials have been copied, so taking swift action is crucial.
.SH "OPTIONS"
.SS "Yank Options"
.sp
Expand Down

0 comments on commit e908f6a

Please sign in to comment.