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

chore(deps): update dependency io_bazel_stardoc to v0.8.0 #421

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 8, 2024

This PR contains the following updates:

Package Type Update Change
io_bazel_stardoc http_archive minor 0.6.2 -> 0.8.0

Release Notes

bazelbuild/stardoc (io_bazel_stardoc)

v0.8.0

Compare Source

New Features

  • Adds support for documenting symbolic macros when using Bazel 8.0.1
    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.2

Compare 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.1

Compare Source

Notable Changes

  • Really fix building with --incompatible_disallow_empty_glob (#​238).
  • Auxiliary rule targets created by stardoc() macro now include provided
    tags (#​247)

Contributors

Alexandre Rostovtsev, Lukács Berki, yashathwani

v0.7.0

Compare Source

This release requires Bazel 7 or newer.

By default - when using Bzlmod for dependency management - Stardoc now uses
@stardoc as its repo name.

For compatibility with the legacy WORKSPACE-based setup (which used
@io_bazel_stardoc as the repo name) and ease of migration, you may load
Stardoc via

bazel_dep(name = "stardoc", repo_name = "io_bazel_stardoc", ...)

in your MODULE.bazel file.

New Features

  • Add support for a table of contents template (#​203). This is disabled by
    default, but Stardoc comes with an example template that you can use. To
    enable, set table_of_contents_template, for example:
    stardoc(
        ...,
        table_of_contents_template = "@​stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",
    )
  • Add support for a footer template (#​206). This is disabled by default; to
    enable, set footer_template to a .vm file, which you will need to provide.
  • Add support for providing stamping to Stardoc templates (#​205). To use,
    use $util.formatBuildTimestamp and $stamping in a template file
    (footer_template - see above - is recommended for this); for example:
    Built on `$util.formatBuildTimestamp($stamping.volatile.BUILD_TIMESTAMP, "UTC", "yyyy-MM-dd HH:mm")`
    
  • Render documentation for provider init callbacks (#​224)
  • Properly render *args, *, and **kwargs in summaries (#​231). This requires
    Bazel 8 (prerelease 2024060 or newer).
  • Include load statement in summaries (#​216)

Incompatible Changes

  • The legacy extractor has been removed (#​212). Stardoc always uses the
    starlark_doc_extract-based extractor. The stardoc, semantic_flags, and
    use_starlark_doc_extract arguments to stardoc() macro have been removed.
  • Stardoc uses Bzlmod by default for dependency management (#​213). This means
    that by default, Stardoc now uses @stardoc as its repo name.

Contributors

Alex Humesky, Alexandre Rostovtsev, Fabian Meumertzheim, Grzegorz Lukasik,
Xùdōng Yáng, Yun Peng


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@renovate renovate bot changed the title chore(deps): update dependency io_bazel_stardoc to v0.7.2 chore(deps): update dependency io_bazel_stardoc to v0.8.0 Jan 23, 2025
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch from b563eaa to b5c4784 Compare January 23, 2025 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants