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.6.2 #12

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 14, 2023

Mend Renovate

This PR contains the following updates:

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

  • The Markdown renderer's source now lives in the Stardoc repo; we build the
    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

v0.5.6

Compare Source

Bugfix release: update @rules_java dependency to fix breakage with Bazel at HEAD.

Contributors

Alexandre Rostovtsev

v0.5.4

Compare Source

New Features

  • Stardoc supports bzlmod! (#​141, special thanks to Fabian Meumertzheim)
  • Stardoc output files are now exposed in stardoc() target runfiles (#​139)

Contributors

Alexandre Rostovtsev, Fabian Meumertzheim, Greg Estren, Ivo List, Keith Smiley,
lberki, Philipp Schrader


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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from sgammon as a code owner August 14, 2023 01:29
@renovate renovate bot added the dependencies Dependency updates and other related issues label Aug 14, 2023
@renovate renovate bot force-pushed the renovate/io_bazel_stardoc-0.x branch from 45557df to d4889d4 Compare August 14, 2023 05:32
@sonarcloud
Copy link

sonarcloud bot commented Aug 14, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Owner

@sgammon sgammon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👎🏻 breaks the build

@sgammon sgammon closed this Aug 14, 2023
@renovate
Copy link
Contributor Author

renovate bot commented Aug 14, 2023

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update (0.6.2). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/io_bazel_stardoc-0.x branch August 14, 2023 05:38
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Dependency updates and other related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant