Template for Bazel rules

Copy this template to create a Bazel ruleset.

Features:

• follows the official style guide at https://bazel.build/rules/deploying
• includes Bazel formatting as a pre-commit hook (using [buildifier])
• includes API documentation generation
• includes typical toolchain setup
• CI configured with GitHub Actions
• release using GitHub Actions just by pushing a tag
• release flow supports GitHub immutable releases
• the release artifact doesn't need to be built by Bazel, but can still exclude files and stamp the version

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 module
2. search for "myorg" and replace with GitHub org
3. search for "mylang", "Mylang", "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. (optional) install the Renovate app to get auto-PRs to keep the dependencies up-to-date.
8. delete this section of the README (everything up to the SNIP).

Optional: if you write tools for your rules to call, you should avoid toolchain dependencies for those tools leaking to all users. For example, https://github.com/aspect-build/rules_py actions rely on a couple of binaries written in Rust, but we don't want users to be forced to fetch a working Rust toolchain. Instead we want to ship pre-built binaries on our GH releases, and the ruleset fetches these as toolchains. See https://blog.aspect.build/releasing-bazel-rulesets-rust for information on how to do this. Note that users who do want to build tools from source should still be able to do so, they just need to register a different toolchain earlier.

Bazel rules for mylang

Installation

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

To use a commit rather than a release, you can point at any SHA of the repo with an archive_override in MODULE.bazel.

For example to use commit abc123:

archive_override(
    module_name = "com_myorg_rules_mylang",
    url = "https://github.com/myorg/rules_mylang/archive/abc123.tar.gz",
    strip_prefix = "rules_mylang-abc123",
    # The easiest way to set this is to commout out this line, then Bazel will print
    # a message with the correct value. Note that GitHub source archives don't have a strong
    # guarantee on the sha256 stability, see <https://github.blog/2023-02-21-update-on-the-future-stability-of-source-code-archives-and-hashes/>
    integrity = "...",
)