chore(deps): update dependency io_bazel_stardoc to v0.8.0 #190
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.8.0Release Notes
bazelbuild/stardoc (io_bazel_stardoc)
v0.8.0Compare Source
New Features
or newer. (Note that the original Bazel 8.0.0 release had a bug causing
macro documentation emitted by Stardoc to be be incomplete.) (#267)
Contributors
Alexandre Rostovtsev, Keith Smiley, Richard Levasseur
v0.7.2Compare Source
Bugfix release: fixes compatibility issues with Bazel 7.4 and 8.0.
Note that this release breaks compatibility with g++ 7.5 (the default
compiler in the Ubuntu 18.04 image) - a new transitive dep requires a
newer c++ compiler version.
Contributors
Alexandre Rostovtsev, Hemanshu Vadehra, Philip Zembrod, Richard Levasseur
v0.7.1Compare Source
Notable Changes
--incompatible_disallow_empty_glob(#238).stardoc()macro now include providedtags(#247)Contributors
Alexandre Rostovtsev, Lukács Berki, yashathwani
v0.7.0Compare Source
This release requires Bazel 7 or newer.
By default - when using Bzlmod for dependency management - Stardoc now uses
@stardocas its repo name.For compatibility with the legacy WORKSPACE-based setup (which used
@io_bazel_stardocas the repo name) and ease of migration, you may loadStardoc via
in your
MODULE.bazelfile.New Features
default, but Stardoc comes with an example template that you can use. To
enable, set
table_of_contents_template, for example:enable, set
footer_templateto a .vm file, which you will need to provide.use
$util.formatBuildTimestampand$stampingin a template file(
footer_template- see above - is recommended for this); for example:initcallbacks (#224)*args,*, and**kwargsin summaries (#231). This requiresBazel 8 (prerelease
2024060or newer).loadstatement in summaries (#216)Incompatible Changes
starlark_doc_extract-based extractor. Thestardoc,semantic_flags, anduse_starlark_doc_extractarguments tostardoc()macro have been removed.that by default, Stardoc now uses
@stardocas its repo name.Contributors
Alex Humesky, Alexandre Rostovtsev, Fabian Meumertzheim, Grzegorz Lukasik,
Xùdōng Yáng, Yun Peng
v0.6.2Compare Source
Bugfix release: bumps
rules_jvm_externaldependency to support building with--incompatible_disable_starlark_host_transitionsContributors
Alexandre Rostovtsev
v0.6.1Compare Source
Bugfix release: fix
rules_jvm_externalpin 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.0Compare 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_extractrule 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
${funcInfo.docString.replaceAll("\n", " ")}you would need
${funcInfo.docString.replaceAll(" ", " ")}When using the native
starlark_doc_extractextractor, Stardoc requirestwo additional templates:
repository_rule_templateandmodule_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_extractextractor, 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 - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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 was generated by Mend Renovate. View the repository job log.