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: CONTRIBUTING.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -385,24 +385,26 @@ The output of the tests will be presented in the command line as well as saved u
385
385
386
386
### Versions
387
387
388
-
To provide a helpful versioning experience, the Azure SDK for Rust libraries follow conventions similar to other Azure SDKs.
388
+
To provide a convenient versioning experience, the Azure SDK for Rust libraries follow conventions similar to other Azure SDKs.
389
389
390
390
Release builds will fail if a library depends on another Azure SDK for Rust library which has not been released and is not included in the current release build.
391
391
392
392
#### Workspace dependencies
393
393
394
-
The root `Cargo.toml` file represents released versions of crates which can be used by other Azure SDK for Rust libraries. To use a released version of a library, use `workspace = true` in your library's `Cargo.toml`.
394
+
The root `Cargo.toml` file represents released versions of crates commonly used by other Azure SDK for Rust libraries. To use a released version of a library, use `workspace = true` in your library's `Cargo.toml`.
395
395
396
396
```toml
397
397
azure_core = { workspace = true }
398
398
```
399
399
400
-
If an SDK library depends on an unreleased SDK library, specify that dependency using a path-based dependency (`version` is required for the library to release):
400
+
If an SDK library depends on an unreleased SDK library, specify that dependency using a `path`-based dependency with a `version`matching the crate version, which is required for the library to release:
401
401
402
402
```toml
403
403
azure_core = { path = "../../core/azure_core", version = "0.31.0" }
404
404
```
405
405
406
+
See <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#inheriting-a-dependency-from-a-workspace> for more information about specifying dependencies in `Cargo.toml`.
407
+
406
408
#### Version increment on release
407
409
408
410
When a release to crates.io completes, the Engineering System opens a pull request to increment versions of released packages. This PR should be merged as soon as possible to put the `main` branch in a "releasable" state and to provide context that code at the HEAD of `main` may not reflect code in a previously released version of a library.
"The following `{}` dependencies do not inherit from workspace `{}`:\n",
120
+
"The following `{}` dependencies do not inherit from workspace `{}` or reference via `path`:\n",
122
121
package_manifest_path.display(),
123
122
workspace_manifest_path.display(),
124
123
);
@@ -131,7 +130,7 @@ fn main() {
131
130
.join("\n* ")
132
131
);
133
132
println!("Add dependencies to workspace and change the package dependency to `{{ workspace = true }}`.");
134
-
println!("See <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#inheriting-a-dependency-from-a-workspace> for more information.");
133
+
println!("See <https://github.com/Azure/azure-sdk-for-rust/blob/main/CONTRIBUTING.md#versions> for more information.");
0 commit comments