Skip to content

Commit c40b6c4

Browse files
author
Jove Zhong
committed
Minor change for how to create crates.io API token
1 parent d475056 commit c40b6c4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Handover.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
[//]: # (SPDX-License-Identifier: Apache-2.0)
33
[//]: # (---)
44

5-
# Handover
5+
# Handover
66

77
Suggested steps to do after the repo transfer:
88

9-
## Add the active maintainer
9+
## Add the active maintainer
1010

1111
Add the new / active maintainer to the following files: MAINTAINERS.md, CODEOWNERS, and CONTRIBUTING.md.
1212

@@ -16,7 +16,7 @@ Add the new / active maintainer to the following files: MAINTAINERS.md, CODEOWNE
1616

1717
## Verify CI / Github actions:
1818

19-
Currently, all GH actions trigger on pull request, unless stated otherwise, assuming[ branch protection is in place](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) (as it should).
19+
Currently, all GH actions trigger on pull request, unless stated otherwise, assuming[ branch protection is in place](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) (as it should).
2020

2121
The following GH actions are pre-configured:
2222

@@ -37,8 +37,8 @@ Rust packages are published to the crates.io registry. To do so, the following s
3737
1) Ensure all changes are comited and pushed to origin. This is important otherwise publish will abort.
3838
2) Verify the pre-defined meta data in Cargo.toml. Repo & homepage is already set to https://github.com/timeplus-io/proton-rust-client
3939
3) Create a free account on https://crates.io/
40-
4) Create an API token in the dashboard
41-
5) Login locally, from a terminal: ```cargo login``` Then at the prompt put in the token specified.
40+
4) Create an API token on https://crates.io/settings/tokens
41+
5) Login locally, from a terminal: ```cargo login``` Then at the prompt put in the token specified.
4242
6) Conduct a dry run to see if everything is correct: ```cargo publish --dry-run```
4343
7) When the dry run completes without error, publish the first version: ```cargo publish```
4444

@@ -48,9 +48,9 @@ https://doc.rust-lang.org/cargo/reference/publishing.html
4848

4949
## Enable auto-release
5050

51-
The conventional Rust release process requires a fair amount of manual steps, such as bumping up version number,
51+
The conventional Rust release process requires a fair amount of manual steps, such as bumping up version number,
5252
adding new git tags, generating changelog, publishing to crates.io etc. For full automation, the release-plz system
53-
has already been pre-configured.
53+
has already been pre-configured.
5454

5555
Release-plz automates your release process:
5656

@@ -64,15 +64,15 @@ Release-plz updates your packages with a release Pull Request based on:
6464
* API breaking changes (detected by cargo-semver-checks).
6565

6666
To enable the release-plz, edit the rust-release file in .github/workflows, uncomment the release-plz section,
67-
and add your crates.io API token as a Github secret.
67+
and add your crates.io API token as a Github secret.
6868

6969
Once the release-plz is enabled, every push to main is added to a generated release PR. When the release PR
70-
is merged, a new Github release is generated fully automatically, a new version is
70+
is merged, a new Github release is generated fully automatically, a new version is
7171
published to the cargo registry, and the documentation is uploaded to rustdocs.org.
7272

7373
For details on how to configure release-plz, consult the documentation:
7474
https://github.com/MarcoIeni/release-plz
7575

7676
For details of how to add a GH secret, see the official GH documentation:
7777

78-
https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions
78+
https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions

0 commit comments

Comments
 (0)