You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Handover.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ Add the new / active maintainer to the following files: MAINTAINERS.md, CODEOWNE
16
16
17
17
## Verify CI / Github actions:
18
18
19
-
Currently, all GH actions trigger on pull requestassuming branch protection is in place (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).
20
20
21
-
THe following GH actions are pre-configured:
21
+
The following GH actions are pre-configured:
22
22
23
23
- audit - security audit against a DB of all known vulnerabilities. Runs on every PR. Active by default.
24
24
- linter / clippy - Checks against a massive database of known Rust lints. Runs on every PR. Active by default.
@@ -38,7 +38,7 @@ Rust packages are published to the crates.io registry. To do so, the following s
38
38
2) Verify the pre-defined meta data in Cargo.toml. Repo & homepage is already set to https://github.com/timeplus-io/proton-rust-client
39
39
3) Create a free account on https://crates.io/
40
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.
41
+
5)Login locally, from a terminal: ```cargo login``` Then at the prompt put in the token specified.
42
42
6) Conduct a dry run to see if everything is correct: ```cargo publish --dry-run```
43
43
7) When the dry run completes without error, publish the first version: ```cargo publish```
44
44
@@ -52,7 +52,7 @@ The conventional Rust release process requires a fair amount of manual steps, su
52
52
adding new git tags, generating changelog, publishing to crates.io etc. For full automation, the release-plz system
53
53
has already been pre-configured.
54
54
55
-
Release-plz automates your relase process:
55
+
Release-plz automates your release process:
56
56
57
57
* CHANGELOG generation (with git-cliff).
58
58
* Creation of GitHub/Gitea releases.
@@ -69,7 +69,7 @@ and add your crates.io API token as a Github secret.
69
69
Once the release-plz is enabled, every push to main is added to a generated release PR. When the release PR
70
70
is merged, a new release is fully automatically published to the cargo registry and the documentation is uploaded to rustdocs.org.
71
71
72
-
For details on how to configure relese-plz, consult the documentation:
72
+
For details on how to configure release-plz, consult the documentation:
73
73
https://github.com/MarcoIeni/release-plz
74
74
75
75
For details of how to add a GH secret, see the official GH documentation:
0 commit comments