Suggeston: Bazel docs #48

New Issue

adam · 2025-12-30T01:19:58+01:00

adam commented

2025-12-30 01:19:58 +01:00

Originally created by @udf2457 on GitHub (Feb 10, 2024).

Please consider adding documentation for interop with Bazel, in particular bzlmod and gazelle.

Thank you

Originally created by @udf2457 on GitHub (Feb 10, 2024). Please consider adding documentation for interop with Bazel, in particular `bzlmod` and `gazelle`. Thank you

adam commented

2025-12-30 01:19:59 +01:00

@silicon-ninja commented on GitHub (Feb 11, 2024):

How do you want it to look like @udf2457 ?

@silicon-ninja commented on GitHub (Feb 11, 2024): How do you want it to look like @udf2457 ?

adam commented

2025-12-30 01:19:59 +01:00

@udf2457 commented on GitHub (Feb 11, 2024):

@silicon-ninja The way I've typically seen it done at other projects is they create an MVP skeleton example repo which has the bare minimum, i.e.:

BUILD
MODULE.bazel
Other project-specific files/folders necessary to demonstrate the functionality (e.g. in your case pkl files located in a sub-folder)

The BUILD would then show the minimum configuration for integration with gazelle (becasue most real-world projects use gazelle). The bzlmod integration itself is inherent from using MODULE.bazel instead of the legacy WORKSPACE.bazel.

So gazelle is used to automatically locate project-specific files (e.g. pkl in your case) and then automatically create a local BUILD file in its immediate directory. Its very popular with e.g. go monorepos, but also other applications (e.g. building gRPC stubs from protobuf files).

Hope this helps clarify ?

@udf2457 commented on GitHub (Feb 11, 2024): @silicon-ninja The way I've typically seen it done at other projects is they create an MVP skeleton `example` repo which has the bare minimum, i.e.: - `BUILD` - `MODULE.bazel` - Other project-specific files/folders necessary to demonstrate the functionality (e.g. in your case `pkl` files located in a sub-folder) The `BUILD` would then show the minimum configuration for integration with `gazelle` (becasue most real-world projects use `gazelle`). The `bzlmod` integration itself is inherent from using `MODULE.bazel` instead of the legacy `WORKSPACE.bazel`. So `gazelle` is used to automatically locate project-specific files (e.g. `pkl` in your case) and then automatically create a local `BUILD` file in its immediate directory. Its very popular with e.g. go monorepos, but also other applications (e.g. building gRPC stubs from protobuf files). Hope this helps clarify ?

adam commented

2025-12-30 01:20:00 +01:00

@silicon-ninja commented on GitHub (Feb 11, 2024):

Well, @udf2457. I've used gazelle before it's great but not yet perfect for anything except rules_go in production as we have a monorepo. I like your idea of using gazelle for BUILD file generation. Did you have a look at gazelle directives. This would eliminate using gazelle directives completely if bazel team were to implement this. I think right now team at apple thought of it more like your typical config files that are used for the systems (primarily backend). To validate and use it with ease. Thanks.

@silicon-ninja commented on GitHub (Feb 11, 2024): Well, @udf2457. I've used `gazelle` before it's great but not yet perfect for anything except `rules_go` in production as we have a monorepo. I like your idea of using gazelle for `BUILD` file generation. Did you have a look at `gazelle directives`. This would eliminate using `gazelle directives` completely if bazel team were to implement this. I think right now team at apple thought of it more like your typical config files that are used for the systems (primarily backend). To validate and use it with ease. Thanks.

adam commented

2025-12-30 01:20:00 +01:00

@dieu commented on GitHub (Feb 27, 2024):

@silicon-ninja, does PKL have integration with Bazel?

@dieu commented on GitHub (Feb 27, 2024): @silicon-ninja, does PKL have integration with Bazel?

adam commented

2025-12-30 01:20:00 +01:00

@silicon-ninja commented on GitHub (Feb 27, 2024):

Not yet, I am trying to write the rules. Maybe this week.

@silicon-ninja commented on GitHub (Feb 27, 2024): Not yet, I am trying to write the rules. Maybe this week.

adam commented

2025-12-30 01:20:01 +01:00

@dieu commented on GitHub (Feb 27, 2024):

@silicon-ninja Nice, looking forward to trying it out.

@dieu commented on GitHub (Feb 27, 2024): @silicon-ninja Nice, looking forward to trying it out.

adam commented

2025-12-30 01:20:01 +01:00

@holzensp commented on GitHub (Apr 23, 2024):

We have now released initial Bazel integration, through rules_pkl. I'm not sure what this Issue asks for specifically (Bazel docs before integration). We do not yet have support for gazelle, because it (and Bazel) doesn't like how Pkl does multi-file output.

The generated Bazel docs don't yet integrate with our website build automation (because they render markdown instead of asciidoc). This is on my TODO list. When this is done, the documentation will be part of https://pkl-lang.org

@holzensp commented on GitHub (Apr 23, 2024): We have now [released initial Bazel integration, through `rules_pkl`](https://github.com/apple/rules_pkl/). I'm not sure what this Issue asks for specifically (Bazel docs before integration). We do not yet have support for `gazelle`, because it (and Bazel) doesn't like how Pkl does multi-file output. The generated Bazel docs don't yet integrate with our website build automation (because they render markdown instead of asciidoc). This is on my TODO list. When this is done, the documentation will be part of https://pkl-lang.org

adam commented

2025-12-30 01:20:01 +01:00

@udf2457 commented on GitHub (May 1, 2024):

I'm not sure what this Issue asks for specifically (Bazel docs before integration)

I thought Apple-peeps were supposed to be geniuses and capable of time travel (docs before integration) @holzensp
😛

In all honesty, the serious answer is you can assume "this issue asks for" a feature request. I will openly admit I could have worded it better / posted it in a better place / whatever.

Nonetheless, thank you for the efforts in getting rules_pkl out, I look forward to trying it out, and of course I will keep my fingers crossed for eventual gazelle integration (followed by docs 😉).

@udf2457 commented on GitHub (May 1, 2024): > I'm not sure what this Issue asks for specifically (Bazel docs before integration) I thought Apple-peeps were supposed to be geniuses and capable of time travel (docs before integration) @holzensp :stuck_out_tongue: In all honesty, the serious answer is you can assume "this issue asks for" a feature request. I will openly admit I could have worded it better / posted it in a better place / whatever. Nonetheless, thank you for the efforts in getting `rules_pkl` out, I look forward to trying it out, and of course I will keep my fingers crossed for eventual `gazelle` integration (followed by docs :wink:).

adam referenced this issue

2025-12-30 01:24:10 +01:00

[PR #48] [CLOSED] Update 02_filling_out_a_template.adoc #386

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/pkl#48