Skip to content
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

Export bzl_library with package files #564

Closed
duarten opened this issue Apr 1, 2022 · 7 comments
Closed

Export bzl_library with package files #564

duarten opened this issue Apr 1, 2022 · 7 comments
Labels
P3 An issue that we are not working on but will review quarterly

Comments

@duarten
Copy link

duarten commented Apr 1, 2022

This allows consumers of rules_pkg to generate docs using stardoc. An example is how skylib does it.

@aiuto
Copy link
Collaborator

aiuto commented Apr 1, 2022

I have a change ready to send as a PR which will provide sources for running stardoc against.
It is blocked behind the backlog of functional changes.
Still, I don't encourage people to use startdoc themselves. It will always be incomplete documentation because the documentation for common attributes comes form other places.
The docs at https://bazelbuild.github.io/rules_pkg/ will be superior to anything you can build on your own for the forseeable future.

@aiuto aiuto added the P3 An issue that we are not working on but will review quarterly label Apr 1, 2022
@duarten
Copy link
Author

duarten commented Apr 1, 2022

Good to know!

Just to clarify, I'm building docs for rules I'm authoring. It's just that stardoc requires the full transitive set of my deps.

@aiuto
Copy link
Collaborator

aiuto commented Apr 6, 2022

#567 has a fix. "@rules_pkg//pkg:bzl_srcs" should be usable as a bzl_library.
If anyone wants to patch that in and give it a try that will be great. Otherwise I'll wait until Friday and merge it anyway.
@guw

@duarten
Copy link
Author

duarten commented Apr 6, 2022

Works perfectly! I still had to add

"@rules_pkg//:mappings.bzl",
"@rules_pkg//:pkg.bzl",
"@rules_pkg//pkg:bzl_srcs",

as dependencies to my bzl_library.

@aiuto
Copy link
Collaborator

aiuto commented Apr 6, 2022 via email

@duarten
Copy link
Author

duarten commented Apr 6, 2022

Ah! Thanks, I was indeed using those instead of the pkg:* variants.

@duarten
Copy link
Author

duarten commented Apr 8, 2022

Closing as this is fixed in 0.7.0.

@duarten duarten closed this as completed Apr 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 An issue that we are not working on but will review quarterly
Projects
None yet
Development

No branches or pull requests

2 participants