Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jin/create-bazel-workspace
Generate a new polyglot Bazel workspace with minimal configuration
https://github.com/jin/create-bazel-workspace
bazel build-system multi-language polyglot
Last synced: about 1 month ago
JSON representation
Generate a new polyglot Bazel workspace with minimal configuration
- Host: GitHub
- URL: https://github.com/jin/create-bazel-workspace
- Owner: jin
- License: apache-2.0
- Created: 2018-06-07T22:04:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-29T06:38:14.000Z (over 6 years ago)
- Last Synced: 2024-07-31T07:15:48.878Z (4 months ago)
- Topics: bazel, build-system, multi-language, polyglot
- Language: Python
- Homepage:
- Size: 36.1 KB
- Stars: 19
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bazel - create-bazel-workspace - Generate a new multi-language Bazel workspace with minimal configuration (Tooling / Project generators)
README
# create-bazel-workspace
Create a polyglot Bazel workspace easily, with sane defaults for multiple languages (layers).
## Quick start
```
$ go get github.com/jin/create-bazel-workspace
$ go install github.com/jin/create-bazel-workspace
$ $GOPATH/bin/create-bazel-workspace -dir ...
```
For example, if you want `go` and `scala`, run
```
$ create-bazel-workspace go scala
```
The default output directory is named `bazel-workspace`.
## Layers
A *layer* contains the following:
- Minimal example that makes use of the layer's rulesets (e.g. `android_binary`
and `android_library` for the `android` layer). This example is available as
a top level target `//:_example` in the generated workspace.
- `WORKSPACE`: Specifies the WORKSPACE content
- `BUILD.bazel`: Specifies the top level BUILD file
- `post_create.txt`: Further instructions for a layer after `create-bazel-workspace`
When you specify multiple layers, files in each layer will be appended to the
`base` layer sequentially.
Supported `` are the the names of the directories in this repository, e.g.
`android`, `scala`, `go`.
## Additional instructions
Depending on the `layer`, there may be more commands to run after
`create-bazel-workspace`. For example, the `go` layer may require running `bazel
run //:gazelle`. These instructions are logged in
`/instructions.md`:
```
$ cat bazel-workspace/instructions.md
# Instructions for the base layer:
Please file issues at https://github.com/jin/create-bazel-workspace
# Instructions for the go layer:
From rules_go, please run:
$ bazel run //:gazelle
This will generate a BUILD.bazel file for each Go package in your repository.
You can run the same command in the future to update existing build files with
new source files, dependencies, and options.
Please file issues at https://github.com/bazelbuild/rules_go
# Instructions for the android layer:
From https://github.com/quittle/bazel_android_sdk_downloader:
$ bazel run @androidsdk//install
This will attempt to download the SDK for the versions specified. If you change
these values, clean the workspace, or check it out fresh, you will need to
re-run this command to download and install the SDK again.
Please file issues at https://github.com/bazelbuild/rules_android
# Instructions for the scala layer:
Please file issues at https://github.com/bazelbuild/rules_scala
```
## Development
This project can be built with Bazel. Build the binary by running
```
$ bazel run //:create-bazel-workspace
```
To regenerate the BUILD files, run
```
$ bazel run //:gazelle
```
To add a new dep, run
```
$ bazel run //:gazelle -- update-repos example.com/dep/repo
```
## Contributing a Layer
To add a layer, open a pull request with new top-level directory named after the layer, containing these files:
- `/WORKSPACE.bzl`
- `/BUILD.bazel.bzl`
- `/post_create.txt`
These files are allowed to be empty.
## Idea
`create-bazel-workspace` is inspired by create-react-app and Spacemacs's concept of layers.