Skip to content

Commit b9c0061

Browse files
authored
Update Release Docs for Cargo Publish (#4989)
1 parent 09cbde0 commit b9c0061

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/Release.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,6 @@ MsQuic may work on other platforms, including macOS, iOS, Android, x86, etc. but
9898
- msquic_windows_x86_Release_openssl.zip
9999
- msquic_windows_x86_Release_openssl3.zip
100100
- msquic_windows_x86_Release_schannel.zip
101-
1. From Linux (use GitHub Codespace) to publish the latest Rust Crate. (CURRENTLY BROKEN)
102-
- Run `cargo publish` from the `release/X.Y` branch.
103101
1. Update (via PR) `main` branch's `test-down-level.yml` to point the newly uploaded `*_test.zip` release binaries.
104102

105103
> **Note** - NuGet packages are automatically published to nuget.org by the pipeline.
@@ -131,6 +129,21 @@ Prerequisites:
131129

132130
For future reference: [Official documentation](https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package)
133131

132+
### Publishing the Rust Crate
133+
134+
The following are the complete (manual) steps for publishing the Rust crate.
135+
136+
1. Create a (Linux) GitHub CodeSpace.
137+
1. `sudo apt update`
138+
1. `sudo apt install curl`
139+
1. `curl https://sh.rustup.rs -sSf | sh`
140+
1. Restart bash.
141+
1. `cargo login`
142+
1. Create an API token on https://crates.io/settings/tokens (with `publish-update` scope).
143+
1. Paste the token into bash.
144+
1. If doing a beta release, update `Cargo.toml` to add a # after `beta` in the version.
145+
1. `cargo publish` or `cargo publish --allow-dirty` if beta release
146+
134147
## Synchronizing with Windows
135148

136149
1. Once the release branch is created, set the pipeline [here](https://mscodehub.visualstudio.com/msquic/_build?definitionId=1868) to ingest the release branch into Windows, and run it.

0 commit comments

Comments
 (0)