This repository contains the Spring Boot rule for the Bazel build system. It enables Bazel to build Spring Boot applications and package them as an executable jar file. The executable jar is the best way to deploy your Spring Boot application in production environments.
The Salesforce springboot rule can be found, along with documentation, in this location:
- bazel-springboot-rule: a Bazel extension to build and package Spring Boot applications
The springboot rule runs on any version of Bazel 1.2.1 or higher. Please do not link to the master branch of this rule in your Bazel workspace, use an official release instead:
This rule was developed and is supported by Salesforce. If you have any issues with this repository, please create a GitHub Issue. We will try to quickly address problems and answer questions.
Ongoing development is planned and tracked using this GitHub repository's Project Manager. To see what bug fixes and new features are planned, consult the roadmaps located there.
Please do us a huge favor. If you think this project could be useful for you, now or in the future, please hit the Star button at the top. That helps us advocate for more time and resources on this project. Thanks!
Before you can use the rule in your BUILD files, you need to add it to your workspace. There are two approaches to doing this.
Reference an official release This loads a pre-built version of this rule into your workspace during the build. It may or may not work for you, as it does not allow you to customize it. On our roadmap we have work items to upgrade this rule to use more modern packaging idioms.
http_archive(
name = "bazel_springboot_rule",
sha256 = "94b0227d73c10fe7566e1faf12e101a8ea18b57322debe90d4ff3494e017592f",
urls = [
"https://github.com/salesforce/bazel-springboot-rule/releases/download/1.1.1/bazel-springboot-rule-1.1.1.zip",
],
)Copy the rule into your workspace (aka vendoring) This may be the quickest option. It allows you to bring in the rule, and make customizations as necessary. We recommend copying it into location //tools/springboot in your workspace but you are free to change this if you like.
Once it is copied in, add this to your WORKSPACE:
local_repository(
name = "bazel_springboot_rule",
path = "tools/springboot",
)Make sure to review the buildstamp documentation as well.
If you don't need to create a runnable executable jar file, there is a simpler approach to Spring Boot in the rules_jvm_external repository. That approach is sufficient if Bazel and your Bazel workspace (i.e. source code) are available in all environments that launch the application.
At Salesforce, Bazel is not available in production environments, and so this alternate approach is not viable.
On that date I switched the repo to use maven_install style dependencies, instead of the obsolete maven_jar (removed as of Bazel 2.x). I tagged the old code line as 1.0.2. To restore the old style, please use the following stanza in your WORKSPACE (to replace whatever you have there).
git_repository(
name = "bazel_springboot_rule",
tag = "1.0.2",
remote = "https://github.com/salesforce/bazel-springboot-rule",
verbose = False,
)The 1.0.2 tag will not be maintained. All new features will be added to master which is currently only maven_install.