drop rules_java dependency
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- python
- 领域
- build-system
调研方向
Start by reading MODULE.bazel and locating the current rules_java dependency and the PlantUML targets that use it. The body proposes a standalone Bazel tool, but marks its draft as unreviewed and leaves both artifact checksums as placeholders. Confirm the intended approach and supported platforms with maintainers; done means the dependency is removed and PlantUML remains usable by the project’s documentation workflow.
由索引模型根据 Issue 内容生成。
描述
rules_java is a FAT dependency. Investigate dropping it.
Unreviewed ChatGPT below.
PlantUML as a standalone Bazel tool
Provide PlantUML as a single executable Bazel target, bundling a pinned Java Runtime (JRE) and the PlantUML JAR.
Goals:
- No
rules_javadependency - No additional Bzlmod module dependencies
- Reproducible Java and PlantUML versions
- No system-wide Java installation required
- Usable through
bazel runand as a tool in other Bazel targets - Compatible with Sphinx /
sphinxcontrib-plantuml
1. Download JRE and PlantUML
In MODULE.bazel:
http_archive = use_repo_rule(
"@bazel_tools//tools/build_defs/repo:http.bzl",
"http_archive",
)
http_file = use_repo_rule(
"@bazel_tools//tools/build_defs/repo:http.bzl",
"http_file",
)
http_archive(
name = "plantuml_jre",
urls = [
"https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.9%2B10/OpenJDK21U-jre_x64_linux_hotspot_21.0.9_10.tar.gz",
],
sha256 = "<JRE_SHA256>",
strip_prefix = "jdk-21.0.9+10-jre",
build_file_content = """
package(default_visibility = ["//visibility:public"])
exports_files(["bin/java"])
filegroup(
name = "runtime",
srcs = glob(["**"]),
)
""",
)
http_file(
name = "plantuml_jar",
urls = [
"https://github.com/plantuml/plantuml/releases/download/v1.2026.9/plantuml-1.2026.9.jar",
],
sha256 = "<PLANTUML_SHA256>",
downloaded_file_path = "plantuml.jar",
)
Replace SHA-256 placeholders with verified checksums from the respective release artifacts.
Both dependencies are registered as external repositories without introducing additional Bzlmod module dependencies.
2. Create an executable Starlark rule
Create tools/plantuml.bzl:
def _runfile_path(file):
path = file.short_path
return path[3:] if path.startswith("../") else path
def _plantuml_impl(ctx):
launcher = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = launcher,
is_executable = True,
content = """#!/usr/bin/env bash
set -euo pipefail
root="${{RUNFILES_DIR:-$0.runfiles}}"
exec "$root/{java}" -Djava.awt.headless=true -jar "$root/{jar}" "$@"
""".format(
java = _runfile_path(ctx.executable.java),
jar = _runfile_path(ctx.file.jar),
),
)
runfiles = ctx.runfiles(
files = [ctx.executable.java, ctx.file.jar],
transitive_files = ctx.attr.jre[DefaultInfo].files,
)
return DefaultInfo(
executable = launcher,
runfiles = runfiles,
)
plantuml_binary = rule(
implementation = _plantuml_impl,
executable = True,
attrs = {
"java": attr.label(
default = "@plantuml_jre//:bin/java",
executable = True,
cfg = "exec",
),
"jre": attr.label(
default = "@plantuml_jre//:runtime",
),
"jar": attr.label(
default = "@plantuml_jar//file",
allow_single_file = True,
),
},
)
The rule:
- Generates an executable shell launcher.
- Includes the complete JRE in its runfiles.
- Includes the PlantUML JAR.
- Executes the bundled Java runtime with
-jar. - Forwards all command-line arguments to PlantUML.
This implementation targets Linux with runfiles directories.
3. Expose PlantUML as a Bazel target
Create tools/BUILD.bazel:
load(":plantuml.bzl", "plantuml_binary")
plantuml_binary(
name = "plantuml",
visibility = ["//visibility:public"],
)
Usage:
bazel run //tools:plantuml -- -version
Generate an SVG:
bazel run //tools:plantuml -- -tsvg diagram.puml
4. Integrate with Sphinx
For sphinxcontrib-plantuml, the executable is configured through:
extensions = ["sphinxcontrib.plantuml"]
plantuml = "/path/to/bazel/plantuml"
The path must point to the executable inside the Bazel execution environment.
When integrating with a custom Bazel docs() rule:
- Declare
//tools:plantumlas an executable tool dependency. - Include the tool's runfiles in the documentation runtime.
- Resolve the executable path at runtime.
- Pass that path into the Sphinx configuration.
Sphinx does not need to know that PlantUML is implemented in Java.
5. Benefits and limitations
| Property | Result |
|---|---|
rules_java required |
No |
| Additional Bzlmod dependencies | None |
| Java installation on host | Not required |
| Java version | Pinned |
| PlantUML version | Pinned |
Usable with bazel run |
Yes |
| Usable in other Bazel targets | Yes |
| Remote execution | Possible with appropriate tool/runfiles integration |
| Cross-platform | Requires platform-specific JREs |
| Graphviz | May be required for some diagram types |
6. Alternative: Native PlantUML executable
PlantUML also publishes experimental native executables.
These could eliminate the Java Runtime entirely:
//tools:plantuml
└── Native PlantUML executable
However, the JAR + pinned JRE approach is preferable if compatibility and reproducibility are more important than minimizing the runtime size.
References
- 主要语言
- Python
- 星标
- 11
- 派生
- 39
- 平均合并
- 1 天 13 小时
- 30 天内合并 PR
- 46
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
eclipse-score/docs-as-code 的其他 Issue
-
bug
难度 1/5 1 小时以内 新手友好度 82/100
eclipse-score/docs-as-code#1031 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
eclipse-score/docs-as-code#1029 ·
维护者通常 1 天内回复
-
intentionally-limited
难度 1/5 1 小时以内 新手友好度 88/100
eclipse-score/docs-as-code#1019 ·
维护者通常 1 天内回复
-
Graph-check unit tests fail under direct pytest because logger fixtures assume Bazel runfiles可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
eclipse-score/docs-as-code#999 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
eclipse-score/docs-as-code#920 · 2 条评论 ·
维护者通常 1 天内回复
查看 eclipse-score/docs-as-code 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
Project-N-E-K-O/N.E.K.O#3670 · 1 条评论 ·
维护者通常 1 天内回复
-
type:docs
难度 2/5 1-3 小时 新手友好度 82/100
jejjohnson/xtremax#123 ·
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
triage
难度 1/5 1 小时以内 新手友好度 78/100
microsoft/agent-framework#10218 ·
维护者通常 1 天内回复
-
fidelity
难度 2/5 半天 新手友好度 66/100
维护者通常 1 天内回复