Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszwawrzyk committed Dec 28, 2023
1 parent a038108 commit 1b9e095
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/docs/configuration/configuration-file/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
4 changes: 2 additions & 2 deletions docs/docs/future-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
18 changes: 9 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 }
Expand Down

0 comments on commit 1b9e095

Please sign in to comment.