Skip to content

Commit 9e42bde

Browse files
authored
Improve crate metadata used on crates.io (#325)
* Updates crate descriptions now that we have several crates. * Adjusts `repository` for the ancillary crates to deep link to their directory in the monorepo, rather than the repository root. This may help with tools like Dependabot, which parse these URLs to find out whether a dependency exists in a subdirectory or not. * Adds explicit `documentation` links since otherwise docs links are missing from search results, due to rust-lang/crates.io#1484. * Adds `keywords` for all user-facing crates (ie everything but the proc-macros crate, since that isn't really buildpacks/CNB specific).
1 parent 16978c1 commit 9e42bde

File tree

6 files changed

+14
-7
lines changed

6 files changed

+14
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[Rustc Version 1.56+]: https://img.shields.io/badge/rustc-1.56+-lightgray.svg
1010
[rustc]: https://blog.rust-lang.org/2021/10/21/Rust-1.56.0.html
1111

12-
`libcnb.rs` is a Rust framework for writing [Cloud Native Buildpacks](https://buildpacks.io) in Rust. It is an opinionated implementation adding language constructs and convenience methods for working with the spec. It values strong adherence to the spec and data formats.
12+
`libcnb.rs` is a framework for writing [Cloud Native Buildpacks](https://buildpacks.io) in Rust. It is an opinionated implementation adding language constructs and convenience methods for working with the spec. It values strong adherence to the spec and data formats.
1313

1414
It currently targets version `0.6` of the CNB spec.
1515

libcnb-cargo/Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ edition = "2021"
55
rust-version = "1.56"
66
license = "BSD-3-Clause"
77
description = "Cargo command for managing buildpacks written with libcnb.rs"
8-
repository = "https://github.com/Malax/libcnb.rs"
8+
keywords = ["buildpacks", "CNB"]
9+
repository = "https://github.com/Malax/libcnb.rs/tree/main/libcnb-cargo"
10+
documentation = "https://docs.rs/libcnb-cargo"
911
readme = "README.md"
1012
include = ["src/**/*", "../LICENSE", "README.md"]
1113

libcnb-data/Cargo.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ version = "0.4.0"
44
edition = "2021"
55
rust-version = "1.56"
66
license = "BSD-3-Clause"
7-
description = "Rust language binding of the Cloud Native Buildpack spec."
8-
repository = "https://github.com/Malax/libcnb.rs"
7+
description = "Types for data formats specified in the Cloud Native Buildpack specification, used by libcnb.rs"
8+
keywords = ["buildpacks", "CNB"]
9+
repository = "https://github.com/Malax/libcnb.rs/tree/main/libcnb-data"
910
documentation = "https://docs.rs/libcnb-data"
1011
readme = "../README.md"
1112
include = ["src/**/*", "../LICENSE", "../README.md"]

libcnb-proc-macros/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ edition = "2021"
55
rust-version = "1.56"
66
license = "BSD-3-Clause"
77
description = "Procedural macros used within libcnb.rs"
8-
repository = "https://github.com/Malax/libcnb.rs"
8+
repository = "https://github.com/Malax/libcnb.rs/tree/main/libcnb-proc-macros"
9+
documentation = "https://docs.rs/libcnb-proc-macros"
910
readme = "../README.md"
1011
include = ["src/**/*", "../LICENSE", "../README.md"]
1112

libcnb-test/Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ edition = "2021"
55
rust-version = "1.56"
66
license = "BSD-3-Clause"
77
description = "An integration testing framework for buildpacks written with libcnb.rs"
8-
repository = "https://github.com/Malax/libcnb.rs"
8+
keywords = ["buildpacks", "CNB"]
9+
repository = "https://github.com/Malax/libcnb.rs/tree/main/libcnb-test"
10+
documentation = "https://docs.rs/libcnb-test"
911
readme = "README.md"
1012
include = ["src/**/*", "../LICENSE", "README.md"]
1113

libcnb/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ version = "0.5.0"
44
edition = "2021"
55
rust-version = "1.56"
66
license = "BSD-3-Clause"
7-
description = "Rust language binding of the Cloud Native Buildpack spec."
7+
description = "A framework for writing Cloud Native Buildpacks in Rust"
8+
keywords = ["buildpacks", "CNB"]
89
repository = "https://github.com/Malax/libcnb.rs"
910
documentation = "https://docs.rs/libcnb"
1011
readme = "../README.md"

0 commit comments

Comments
 (0)