Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore(deps): update dependency io_bazel_stardoc to v0.6.2 #143

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 7, 2023

Mend Renovate

This PR contains the following updates:

Package Type Update Change
io_bazel_stardoc http_archive minor 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

    my_rule = rule(
        doc = """
        This is my rule.
    
        Here is more info about it.
    
        ...
        """,
        ...
    )

    and Stardoc will dedent and trim the doc to

    This is my rule.
    
    Here is more info about it.
    
    ...
    
  • 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:

    • correct default values for rule attributes in all cases
    • documentation for module extensions
    • more complete documentation for repository rules
    • by default (this can be turned off via 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_extract extractor, Stardoc requires
    two additional templates: repository_rule_template and
    module_extension_template. If you are using custom templates, you will
    probably want to define these, following the examples in
    stardoc/templates/markdown_tables.

  • When using the native starlark_doc_extract extractor, Stardoc cannot
    document generated .bzl files any more - because Bazel cannot load()
    generated .bzl files.

Other Notable Changes

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.


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

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the deps Renovate PRs label Aug 7, 2023
@renovate renovate bot changed the title chore(deps): update dependency io_bazel_stardoc to v0.6.1 chore(deps): update dependency io_bazel_stardoc to v0.6.2 Aug 11, 2023
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch from 2cb2500 to c65fee7 Compare August 11, 2023 21:10
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch 2 times, most recently from 15fb5c5 to ab8f1d9 Compare October 3, 2023 00:17
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch from ab8f1d9 to 564c06a Compare October 11, 2023 04:26
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch from 564c06a to 81a5653 Compare February 5, 2024 05:46
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
deps Renovate PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants