From aceae5b4c0db751474521a544d95f97638f590b9 Mon Sep 17 00:00:00 2001 From: Peter Laird Date: Sat, 7 Dec 2024 18:30:31 -0700 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8bed00c..f68dddf 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,21 @@ To see what bug fixes and new features are planned, consult the roadmaps located Before you can use the rule in your BUILD files, you need to add it to your workspace. -**Reference an official release** -This loads a pre-built version of this rule into your workspace during the build. -This is the recommended approach for most users. +**Bzlmod** +We aren't currently listed in the Bazel Central Registry (hopefully this will be fixed soon). +``` +bazel_dep(name = "rules_spring", version = "2.4.1") +git_override( + module_name = "rules_spring", + remote = "https://github.com/salesforce/rules_spring", + commit="29b4142597e54c49766b8c9b231cd098c2ea2b12", +) +``` + +**WORKSPACE (legacy)** + +This loads a pre-built version of this rule into your workspace during the build. ```starlark http_archive( name = "rules_spring", @@ -39,7 +50,7 @@ http_archive( ) ``` -**Do not use a git_repository rule with our main branch** +Do not use a git_repository rule with our main branch. If you choose not to use an official release, you may be tempted to use a *git_repository* workspace rule to point to our *main* branch, Please **do not** do this, as we use *main* for ongoing work.