diff --git a/docs/docs/configuration/configuration-file/index.md b/docs/docs/configuration/configuration-file/index.md index 3a69c5bc..8899f313 100644 --- a/docs/docs/configuration/configuration-file/index.md +++ b/docs/docs/configuration/configuration-file/index.md @@ -93,7 +93,7 @@ Bazel Steward has multiple configuration sections: * `post-update-hooks` Each section contains a list of *rules*. Apart from fields specific to given section, each rule can contain special fields used for filtering: `kinds` and `dependencies`. -* `kinds` - a kind of a dependency, can be one of `maven`, `bazel`, `bazel-rules`. Useful to for example specify specific search paths for all maven dependencies. +* `kinds` - a kind of dependency, can be one of `maven`, `bazel`, `bazel-rules`, `bzlmod`. Useful to for example specify specific search paths for all maven dependencies. * `dependencies` - names of dependencies. Maven dependencies are in form of `"{group}:{artifact}"`. Wildcard in form of `*` is allowed. For advanced use cases it is possible to use regex for matching using `"regex:YOUR_REGEX"` syntax. Useful for library specific settings, like overriding versioning schema. These fields can be either a single string value or a list of values. In case of a list, the search predicate uses `or`. diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 8ab53803..d2c27cc1 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -8,5 +8,5 @@ has_children: true # Configuration After installation, Bazel Steward works out of the box without any extra configuration. -If needed, it can be customized. It is primarily configured by a `yaml` configuration file that is commited into the repository. -Additionally some behavior is configured by command line arguments. \ No newline at end of file +If needed, it can be customized. It is primarily configured by a `yaml` configuration file that is committed into the repository. +Additionally, some behavior is configured by command line arguments. \ No newline at end of file diff --git a/docs/docs/future-plans.md b/docs/docs/future-plans.md index 53c62b93..628e1875 100644 --- a/docs/docs/future-plans.md +++ b/docs/docs/future-plans.md @@ -9,9 +9,9 @@ nav_order: 5 Currently Bazel Steward supports: * Bazel version - defined in .bazelversion or .bazeliskrc file. * Maven dependencies added through the rules_jvm_external -* Bazel rules +* Bazel rules (and bazel modules) -We plan to extend the support to update bazel modules, http_archives and languages like Go, Python or JavaScript and more. +We plan to extend the support to update http_archives and languages like Go, Python or JavaScript and more. We are also planning to support more git hosting methods, but for now, we only support GitHub. diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 5e36853b..8754d7f7 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -109,13 +109,13 @@ Bazel Steward is published to Maven Central under `org.virtuslab:bazel-steward`. To easily run it, use [Coursier](https://get-coursier.io/docs/cli-installation). ``` -coursier launch org.virtuslab:bazel-steward:1.1.0 --main org.virtuslab.bazelsteward.app.Main -- --help +coursier launch org.virtuslab:bazel-steward:1.2.0 --main org.virtuslab.bazelsteward.app.Main -- --help ``` ## GitHub Releases Bazel Steward publishes a fat JAR under GitHub Releases. The same JAR is also used in GitHub Actions. You can simply download it and run using the `java` command. ``` -wget https://github.com/VirtusLab/bazel-steward/releases/download/v1.1.0/bazel-steward.jar +wget https://github.com/VirtusLab/bazel-steward/releases/download/v1.2.0/bazel-steward.jar java -jar bazel-steward.jar --help ``` diff --git a/docs/index.md b/docs/index.md index afa90618..3c6760b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ If a newer version is available in the upstream, Bazel Steward opens a pull requ Bazel Steward supports updating: * Maven dependencies from `rules_jvm_external` (requires rules version `4.0.0` or newer) - * Bazel rules itself (like rules_python, rules_docker etc.) + * Bazel rules (like rules_python, rules_docker etc.) both in WORKSPACE and MODULE files. * Bazel version (defined in `.bazelversion` or `.bazeliskrc` file) Please let us know if you would like to use Bazel Steward with other kinds of dependencies. @@ -47,14 +47,14 @@ on: schedule: - cron: '30 5 * * *' # runs every day at 5:30 am - jobs: - bazel-steward: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - uses: VirtusLab/bazel-steward@latest +jobs: + bazel-steward: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: VirtusLab/bazel-steward@latest ``` {: .note }