pziggo / rules-template

A template for creating a new Bazel ruleset

Template for Bazel rules

Copy this template to create a Bazel ruleset.

Features:

• follows the official style guide at https://docs.bazel.build/versions/main/skylark/deploying.html
• includes Bazel formatting as a pre-commit hook (using buildifier)
• includes stardoc API documentation generator
• includes typical toolchain setup
• CI configured with GitHub Actions
• Release on GitHub Actions when pushing a tag

See https://docs.bazel.build/versions/main/skylark/deploying.html#readme

Ready to get started? Copy this repo, then

1. search for "com_myorg_rules_mylang" and replace with the name you'll use for your workspace
2. search for "myorg" and replace with GitHub org
3. search for "mylang" and replace with the language/tool your rules are for
4. rename directory "mylang" similarly
5. run pre-commit install to get lints (see CONTRIBUTING.md)
6. if you don't need to fetch platform-dependent tools, then remove anything toolchain-related.
7. update the actions/cache@v2 bazel cache key in .github/workflows/ci.yaml and .github/workflows/release.yml to be a hash of your source files.
8. (optional) install the Renovate app to get auto-PRs to keep the dependencies up-to-date.
9. delete this section of the README (everything up to the SNIP).

---- SNIP ----

Bazel rules for mylang

Installation

From the release you wish to use: https://github.com/myorg/rules_mylang/releases copy the WORKSPACE snippet into your WORKSPACE file.