bazel-contrib / bcr-ui

Website for the Bazel Central Registry
https://registry.bazel.build
Apache License 2.0
17 stars 8 forks source link

Find a way to embed/link to the "usage snippet" of a module #35

Closed hobofan closed 1 year ago

hobofan commented 1 year ago

Most rulesets don't provide a lot of value based on the one-liner snippet we offer for copy-pasting via the UI (e.g. all that involve package manager usage).

Example of more involved copy-pastable boilerplate: https://github.com/bazelbuild/rules_python/releases/tag/0.15.0

Right now there is no clear way about how we could include that, without including it as a metadata field in the BCR (which is undesirable for multiple reasons. What we could do is adding a link to the repository (and their release notes, where the snippet is most often found) based on the repository key in the metadata.json.