Skip to content

Commit

Permalink
chore(deps): update dependency io_bazel_stardoc to v0.7.0 (#441)
Browse files Browse the repository at this point in the history
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [io_bazel_stardoc](https://togithub.com/bazelbuild/stardoc) |
http_archive | minor | `0.6.2` -> `0.7.0` |

---

### Release Notes

<details>
<summary>bazelbuild/stardoc (io_bazel_stardoc)</summary>

###
[`v0.7.0`](https://togithub.com/bazelbuild/stardoc/blob/HEAD/CHANGELOG.md#Release-070)

[Compare
Source](https://togithub.com/bazelbuild/stardoc/compare/0.6.2...0.7.0)

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

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

in your `MODULE.bazel` file.

**New Features**

- Add support for a table of contents template
([#&#8203;203](https://togithub.com/bazelbuild/stardoc/issues/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:
    ```bzl
    stardoc(
        ...,
table_of_contents_template =
"@&#8203;stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",
    )
    ```
- Add support for a footer template
([#&#8203;206](https://togithub.com/bazelbuild/stardoc/issues/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
([#&#8203;205](https://togithub.com/bazelbuild/stardoc/issues/205)). To
use,
    use `$util.formatBuildTimestamp` and `$stamping` in a template file
(`footer_template` - see above - is recommended for this); for example:
    ```vm
Built on `$util.formatBuildTimestamp($stamping.volatile.BUILD_TIMESTAMP,
"UTC", "yyyy-MM-dd HH:mm")`
    ```
- Render documentation for provider `init` callbacks
([#&#8203;224](https://togithub.com/bazelbuild/stardoc/issues/224))
- Properly render `*args`, `*`, and `**kwargs` in summaries
([#&#8203;231](https://togithub.com/bazelbuild/stardoc/issues/231)).
This requires
Bazel 8 (prerelease
[`2024060`](https://togithub.com/bazelbuild/stardoc/commit/20240603) or
newer).
- Include `load` statement in summaries
([#&#8203;216](https://togithub.com/bazelbuild/stardoc/issues/216))

**Incompatible Changes**

- The legacy extractor has been removed
([#&#8203;212](https://togithub.com/bazelbuild/stardoc/issues/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
([#&#8203;213](https://togithub.com/bazelbuild/stardoc/issues/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

</details>

---

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

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMDkuNCIsInVwZGF0ZWRJblZlciI6IjM2LjEwOS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>
  • Loading branch information
cgrindel-self-hosted-renovate[bot] and Self-hosted Renovate Bot authored Jun 20, 2024
1 parent ffb0cb8 commit 6e648c3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions deps.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ def _bazeldoc_dependencies():
maybe(
http_archive,
name = "io_bazel_stardoc",
sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432",
sha256 = "dd7f32f4fe2537ce2452c51f816a5962d48888a5b07de2c195f3b3da86c545d3",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
"https://github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
"https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.7.0/stardoc-0.7.0.tar.gz",
"https://github.com/bazelbuild/stardoc/releases/download/0.7.0/stardoc-0.7.0.tar.gz",
],
)

Expand Down

0 comments on commit 6e648c3

Please sign in to comment.