bazelbuild/stardoc (io_bazel_stardoc)
### [`v0.7.1`](https://redirect.github.com/bazelbuild/stardoc/blob/HEAD/CHANGELOG.md#Release-071)
[Compare Source](https://redirect.github.com/bazelbuild/stardoc/compare/0.7.0...0.7.1)
**Notable Changes**
- Really fix building with `--incompatible_disallow_empty_glob` ([#238](https://redirect.github.com/bazelbuild/stardoc/issues/238)).
- Auxiliary rule targets created by `stardoc()` macro now include provided
`tags` ([#247](https://redirect.github.com/bazelbuild/stardoc/issues/247))
**Contributors**
Alexandre Rostovtsev, Lukács Berki, yashathwani
### [`v0.7.0`](https://redirect.github.com/bazelbuild/stardoc/blob/HEAD/CHANGELOG.md#Release-070)
[Compare Source](https://redirect.github.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 ([#203](https://redirect.github.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 = "@stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",
)
```
- Add support for a footer template ([#206](https://redirect.github.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 ([#205](https://redirect.github.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 ([#224](https://redirect.github.com/bazelbuild/stardoc/issues/224))
- Properly render `*args`, `*`, and `**kwargs` in summaries ([#231](https://redirect.github.com/bazelbuild/stardoc/issues/231)). This requires
Bazel 8 (prerelease [`2024060`](https://redirect.github.com/bazelbuild/stardoc/commit/20240603) or newer).
- Include `load` statement in summaries ([#216](https://redirect.github.com/bazelbuild/stardoc/issues/216))
**Incompatible Changes**
- The legacy extractor has been removed ([#212](https://redirect.github.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 ([#213](https://redirect.github.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
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 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 contains the following updates:
0.6.2->0.7.1Release Notes
bazelbuild/stardoc (io_bazel_stardoc)
### [`v0.7.1`](https://redirect.github.com/bazelbuild/stardoc/blob/HEAD/CHANGELOG.md#Release-071) [Compare Source](https://redirect.github.com/bazelbuild/stardoc/compare/0.7.0...0.7.1) **Notable Changes** - Really fix building with `--incompatible_disallow_empty_glob` ([#238](https://redirect.github.com/bazelbuild/stardoc/issues/238)). - Auxiliary rule targets created by `stardoc()` macro now include provided `tags` ([#247](https://redirect.github.com/bazelbuild/stardoc/issues/247)) **Contributors** Alexandre Rostovtsev, Lukács Berki, yashathwani ### [`v0.7.0`](https://redirect.github.com/bazelbuild/stardoc/blob/HEAD/CHANGELOG.md#Release-070) [Compare Source](https://redirect.github.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 ([#203](https://redirect.github.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 = "@stardoc//stardoc:templates/markdown_tables/table_of_contents.vm", ) ``` - Add support for a footer template ([#206](https://redirect.github.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 ([#205](https://redirect.github.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 ([#224](https://redirect.github.com/bazelbuild/stardoc/issues/224)) - Properly render `*args`, `*`, and `**kwargs` in summaries ([#231](https://redirect.github.com/bazelbuild/stardoc/issues/231)). This requires Bazel 8 (prerelease [`2024060`](https://redirect.github.com/bazelbuild/stardoc/commit/20240603) or newer). - Include `load` statement in summaries ([#216](https://redirect.github.com/bazelbuild/stardoc/issues/216)) **Incompatible Changes** - The legacy extractor has been removed ([#212](https://redirect.github.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 ([#213](https://redirect.github.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 PengConfiguration
📅 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 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.