diff --git a/docs/usage/bazel.md b/docs/usage/bazel.md index 38237d88b9cf09ebcae4d15fb8373194bcf709e1..b5e6cfda4d2d8f46451e07d9d131d03f38e11d28 100644 --- a/docs/usage/bazel.md +++ b/docs/usage/bazel.md @@ -7,22 +7,22 @@ description: Bazel dependencies support in Renovate Renovate supports upgrading dependencies in Bazel `WORKSPACE` files. -## How It Works +## How it works -1. Bazel support is enabled automatically, so you do not have to explicitly configure it to be enabled -2. Renovate will search repositories for any `WORKSPACE` files in the repository -3. Existing dependencies will be extracted from `git_repository` and `http_archive` declarations -4. Renovate will replace any old versions with the latest version available +1. Bazel support is enabled automatically +2. Renovate will search repositories for any `WORKSPACE` files in the repository +3. Existing dependencies will be extracted from `git_repository` and `http_archive` declarations +4. Renovate will replace any old versions with the latest version available ## git_repository Renovate will update any `git_repository` declaration that contains the following: -1. name -2. remote matching `https://github.com/<owner>/<repo>.git` -3. tag using a valid semver +1. name +2. remote matching `https://github.com/<owner>/<repo>.git` +3. tag using a valid SemVer -Example: +e.g.: ``` git_repository( @@ -32,17 +32,17 @@ git_repository( ) ``` -New versions will be detected using the list of **tags** for that repository on GitHub. +Renovate uses the list of **tags** on the remote repository (GitHub) to detect a new version. ## http_archive and http_file Renovate will update any `http_archive` or `http_file` declaration that contains the following: -1. name -2. url matching `https://github.com/<owner>/<repo>/releases/download/<semver>/<repo>.tar.gz` -3. sha256 +1. name +2. url matching `https://github.com/<owner>/<repo>/releases/download/<semver>/<repo>.tar.gz` +3. sha256 -Example: +e.g.: ``` http_archive( @@ -52,7 +52,7 @@ http_archive( ) ``` -New versions will be detected using the list of **releases** for that repository on GitHub. +Renovate uses the list of **releases** that it finds at the `url` to detect a new version. ## Future work