Skip to content

docs: Automated documentation sync from recent code commits.#29170

Open
deepalak56 wants to merge 1 commit intobazelbuild:masterfrom
deepalak56:auto-doc-sync-1774982947
Open

docs: Automated documentation sync from recent code commits.#29170
deepalak56 wants to merge 1 commit intobazelbuild:masterfrom
deepalak56:auto-doc-sync-1774982947

Conversation

@deepalak56
Copy link
Copy Markdown
Contributor

@deepalak56 deepalak56 commented Mar 31, 2026

Description

This PR performs an automated synchronization of technical documentation based on recent Bazel code changes. This is to surgically update, replace, or append documentation notes to both DevSite (.md) and Mintlify (.mdx) files.

Commits processed in this run:

14fc007: Added disk cache support for default locations (Updated remote/cache-local).
ffebc5b: Added support for dynamic inputs with remote repository content (Updated external/repo).
a39cef7: Introduced an implicit _sort_key field to module extensions (Updated external/extension).

Motivation

This change ensures that Bazel's technical documentation remains in lockstep with the source code. By automating the mapping of RELNOTES and commit diffs to the relevant documentation sections, we reduce manual maintenance toil and prevent documentation rot.

Build API Changes

No

Checklist

[ ] I have added tests for the new use cases (if any).

[x] I have updated the documentation (if applicable).

Release Notes

RELNOTES: None

@deepalak56 deepalak56 changed the title docs: Automated documentation sync from recent RELNOTES docs: Automated documentation sync from recent code commits. Mar 31, 2026
@github-actions github-actions bot added team-Documentation Documentation improvements that cannot be directly linked to other team labels awaiting-review PR is awaiting review from an assigned reviewer labels Mar 31, 2026
@iancha1992 iancha1992 added the team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website label Mar 31, 2026
to be watched in other ways.
* When `bazel fetch --force` is executed.

There are two parameters of `repository_rule` that control when the repositories
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think this block should have been deleted

```python
# @rules_jvm_external//:extensions.bzl

Each tag instance object now has an implicit `_sort_key` integer field.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This text block should not be inside the fenced code block.


The function has exactly one input parameter, `repository_ctx`. The function

* **Remote Caching:** The remote repository contents cache (`--experimental_remote_repo_cache`) now supports all reproducible repository rules, including those with dynamic inputs discovered during execution.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This block was inserted into a sentence and should be moved

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file") # a repo rule
def _maven_impl(ctx):

Each tag instance object now has an implicit `_sort_key` integer field.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same problem as above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-review PR is awaiting review from an assigned reviewer team-Documentation Documentation improvements that cannot be directly linked to other team labels team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants