README
¶
update-workspace-snippets
update-workspace-snippets is a small tool to update README snippets for
Bazel WORKSPACE and MODULE.bazel files. See the Go package
documentation for details and usage instructions.
This is not an officially supported Google product.
Documentation
¶
Overview ¶
Binary update-workspace-snippets automatically updates snippets for Bazel WORKSPACE and MODULE.bazel files. These snippets should follow the format described in https://bazel.build/rules/deploying#readme.
Usage ¶
A command like
update-workspace-snippets filename…
updates the specified files so that the workspace and module snippets in these files point to the latest commit available on GitHub. Right now this only supports commits on the main branch; releases aren’t supported yet. The current directory must be in a Git repository that has exactly one remote pointing to a GitHub repository. The listed files should contain at least one “git_override” or “http_archive” stanza pointing to the GitHub repository. The program also updates comments within the stanza that look like dates.
Invoke this program after pushing to GitHub. Since it modifies the workspace, you’ll typically need to commit and push again, but since it only updates documentation, pointing to the previous commit is fine.
Source Files
Directories