https://github.com/keith/rules_multirun

Bazel rules for running multiple commands in parallel in a single bazel invocation
https://github.com/keith/rules_multirun

Last synced: 3 days ago
JSON representation

Bazel rules for running multiple commands in parallel in a single bazel invocation

• Host: GitHub
• URL: https://github.com/keith/rules_multirun
• Owner: keith
• License: apache-2.0
• Created: 2022-05-10T20:36:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T19:10:32.000Z (22 days ago)
• Last Synced: 2024-10-22T09:09:48.490Z (22 days ago)
• Language: Starlark
• Size: 64.5 KB
• Stars: 77
• Watchers: 6
• Forks: 15
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rules_multirun

These rules provide a simple interface for running multiple commands in

parallel with a single `bazel run` invocation. This is especially useful

for running multiple linters or formatters with a single command.

## Usage

Setup the tools you want to run:

```bzl

load("@rules_multirun//:defs.bzl", "command", "multirun")

load("@rules_python//python:defs.bzl", "py_binary")

sh_binary(

    name = "some_linter",

    ...

)

py_binary(

    name = "some_other_linter",

    ...

)

command(

    name = "lint-something",

    command = ":some_linter",

    arguments = ["check"], # Optional arguments passed directly to the tool

)

command(

    name = "lint-something-else",

    command = ":some_other_linter",

    environment = {"CHECK": "true"}, # Optional environment variables set when invoking the command

    data = ["..."] # Optional runtime data dependencies

)

multirun(

    name = "lint",

    commands = [

        "lint-something",

        "lint-something-else",

    ],

    jobs = 0, # Set to 0 to run in parallel, defaults to sequential

)

```

Run the `multirun` target with bazel:

```sh

$ bazel run //:lint

```

See [the full API docs](doc) for more info.

## Usage with platform transitions

In case if the `multirun` rule requires a transition to other configuration than `target` then

a new `multirun`-like rule can be defined as in the following example

```bzl

load("@rules_multirun//:defs.bzl", "multirun_with_transition")

def _aws_deploy_platforms_impl(settings, attr):

    return {"//command_line_option:platforms": [":aws_lambda"]}

aws_deploy_transition = transition(

    implementation = _aws_deploy_platforms_impl,

    inputs = [],

    outputs = ["//command_line_option:platforms"],

)

aws_deploy = multirun_with_transition(

    aws_deploy_transition,

    "@bazel_tools//tools/allowlists/function_transition_allowlist"

)

```

and used in a `BUILD` file

```bzl

aws_deploy(

    name = "staging",

    commands = [

       ...

    ]

)

```

## Installation

Go to the [releases

page](https://github.com/keith/rules_multirun/releases) to grab the

WORKSPACE snippet for the latest release.

## Acknowledgements

This is a fork of the [original multirun

rules](https://github.com/ash2k/bazel-tools). Those rules have a

dependency on golang to run, which may not be desired, these rules use a

[python script](internal/multirun.py) instead.