Skip to content

Improve crate metadata used on crates.io #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2022

Conversation

edmorley
Copy link
Member

  • 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 docs.rs link is missing from search results 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).

* 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).
@edmorley edmorley added documentation Improvements or additions to documentation skip changelog labels Feb 16, 2022
@edmorley edmorley self-assigned this Feb 16, 2022
@edmorley edmorley requested a review from Malax February 16, 2022 12:38
@edmorley edmorley merged commit 9e42bde into main Feb 16, 2022
@edmorley edmorley deleted the edmorley/improve-crate-metadata branch February 16, 2022 13:36
@edmorley edmorley added this to the libcnb 0.6.0 milestone Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants