chore(deps): update dependency io_bazel_stardoc to v0.6.2 #143
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.5.6
->0.6.2
Release Notes
bazelbuild/stardoc (io_bazel_stardoc)
v0.6.2
Compare Source
Bugfix release: bumps
rules_jvm_external
dependency to support building with--incompatible_disable_starlark_host_transitions
Contributors
Alexandre Rostovtsev
v0.6.1
Compare Source
Bugfix release: fix
rules_jvm_external
pin warnings.This release temporarily restores compatibility with Bazel 5 (manually tested).
Note that normally we only test Stardoc with the current stable Bazel and with
Bazel at HEAD - not with older releases. We make no promises about maintaining
compatibility with Bazel 5.
Contributors
Alexandre Rostovtsev
v0.6.0
Compare Source
New Features
Stardoc no longer escapes HTML tags in documentation. Feel free to
use HTML formatting in your docs! We now also have much-improved
rendering for fenced code blocks in attribute docs, and render attribute
default values using Markdown instead of HTML markup. (#161, #167)
Stardoc now dedents and trims all doc strings - not only in macros (#170).
This means you can have
and Stardoc will dedent and trim the doc to
When using Bazel 7 or newer (or current Bazel HEAD), Stardoc will by
default use the native
starlark_doc_extract
rule internally (#166).This means, in particular:
render_main_repo_name = False
),we will render labels in your main repo with a repo component: your
main module name (when using bzlmod) or WORKSPACE name (#168).
You may temporarily disable the new extractor by calling Stardoc with
use_starlark_doc_extract = False
. However, after Bazel 7 is released,we plan to remove this argument and always use the new extractor.
Incompatible Changes
The Markdown renderer now uses Google EscapeVelocity instead of Apache
Velocity for templating. The templating engines are almost compatible,
with the exception of escapes in string literals: if in your template you
had a string literal with a character escape, you would need to expand it.
For example, instead of
you would need
When using the native
starlark_doc_extract
extractor, Stardoc requirestwo additional templates:
repository_rule_template
andmodule_extension_template
. If you are using custom templates, you willprobably want to define these, following the examples in
stardoc/templates/markdown_tables
.When using the native
starlark_doc_extract
extractor, Stardoc cannotdocument generated .bzl files any more - because Bazel cannot
load()
generated .bzl files.
Other Notable Changes
renderer from source instead of using a bundled jar. Unfortunately, if you
are not using bzlmod, this requires a rather complicated WORKSPACE setup;
see https://github.com/bazelbuild/stardoc/releases/tag/0.6.0
Contributors
Alexandre Rostovtsev, Fabian Meumertzheim
Configuration
📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.