diff options
Diffstat (limited to 'ops/yandex-cloud-rs')
| -rw-r--r-- | ops/yandex-cloud-rs/Cargo.toml | 2 | ||||
| -rw-r--r-- | ops/yandex-cloud-rs/README.md | 51 |
2 files changed, 53 insertions, 0 deletions
diff --git a/ops/yandex-cloud-rs/Cargo.toml b/ops/yandex-cloud-rs/Cargo.toml index c476421dc712..4ba1ea94a8bf 100644 --- a/ops/yandex-cloud-rs/Cargo.toml +++ b/ops/yandex-cloud-rs/Cargo.toml @@ -3,6 +3,8 @@ name = "yandex-cloud" description = "Generated gRPC clients for the Yandex Cloud API" version = "2023.4.24" edition = "2021" +homepage = "https://cs.tvl.fyi/depot/-/tree/ops/yandex-cloud-rs" +repository = "https://code.tvl.fyi/depot.git:/ops/yandex-cloud-rs.git" [dependencies] prost = "0.11" diff --git a/ops/yandex-cloud-rs/README.md b/ops/yandex-cloud-rs/README.md new file mode 100644 index 000000000000..76d80c760ed9 --- /dev/null +++ b/ops/yandex-cloud-rs/README.md @@ -0,0 +1,51 @@ +yandex-cloud-rs +=============== + +Client library for Yandex Cloud gRPC APIs, as published in their +[GitHub repository][repo]. + +Please see the [online documentation][docs] for user-facing +information, this README is intended for library developers. + +The source code of the library lives [in the TVL repository][code]. + +------------- + +In order to build this library, the gRPC API definitions need to be +fetched from GitHub. By default this is done by Nix (see +`default.nix`), which then injects the location of the API definitions +through the `YANDEX_CLOUD_PROTOS` environment variable. + +The actual code generation happens through the calls in `build.rs`. + +Releases of this library are done from *dirty* trees, meaning that the +version on crates.io should already contain all the generated code. In +order to do this, after bumping the version in `Cargo.toml` and the +API commit in `default.nix`, the following release procedure should be +used: + +``` +# Get rid of all generated source files +cd src +ls | grep -v '^lib.rs$' | xargs rm +cd .. + +# Get rid of all old artefacts +cargo clean + +# Verify that a clean build works as intended +cargo build + +# Verify that all documentation builds, and verify that it looks fine: +# +# - Is the version correct (current date)? +# - Are all the services included (i.e. not an accidental empty build)? +cargo doc --open + +# If everything looks fine, release: +cargo publish --allow-dirty +``` + +[repo]: https://github.com/yandex-cloud/cloudapi +[docs]: https://docs.rs/yandex-cloud/latest/yandex_cloud/ +[code]: https://cs.tvl.fyi/depot/-/tree/ops/yandex-cloud-rs |