| fweikert | 69895ba | 2022-07-13 04:56:04 -0700 | [diff] [blame] | 1 | # Bazel Release Documentation |
| 2 | |
| 3 | This directory contains scripts to build the versioned documentation for a new Bazel release. |
| 4 | |
| 5 | ## Build release documentation |
| 6 | |
| 7 | You can build the release documentation by running this command from within a release branch: |
| 8 | |
| 9 | ``` |
| 10 | bazel build //scripts/docs:gen_release_docs --config=docs |
| 11 | ``` |
| 12 | |
| 13 | This is only necessary for testing, though. There is a separate pipeline that handles this task for actual Bazel releases. |
| 14 | |
| 15 | ## Test scripts |
| 16 | |
| 17 | You can test some of the scripts by running the following command: |
| 18 | |
| 19 | ``` |
| 20 | bazel test --test_output=streamed //scripts/docs:rewriter_test |
| 21 | ``` |
