support pinning vivarium_build_utils (#269)

Author: stevebachmeier

CHANGELOG.rst

@@ -1,3 +1,7 @@
+**2.1.15 - 07/16/25**
+
+  - Support pinning of vivarium_build_utils; pin vivarium_build_utils>=1.1.0,<2.0.0
+
 **2.1.14 - 06/16/25**
 
   - Type-hinting: Fix mypy errors in psimulate/cluster/cli_options.py

Jenkinsfile

@@ -1,4 +1,32 @@
-@Library("vivarium_build_utils") _
+/* This Jenkinsfile simply loads the `reusable_pipeline` pipeline from the
+vivariu_build_utils repository (https://github.com/ihmeuw/vivarium_build_utils).
+
+vivarium_build_utils is loaded as a Jenkins shared library 
+(https://www.jenkins.io/doc/book/pipeline/shared-libraries/).
+Jenkins shared library convention dictates that importable modules must be stored
+in the 'vars' folder.
+
+Jenkins shared libraries can be configured in the Jenkins UI:
+* Manage Jenkins
+  * Configure System
+    * Global Pipeline Libraries section
+      * Library subsection
+        * Name: The Name for the lib
+        * Version: The branch you want to use. Throws an error
+                   for nonexistent branches.
+        * Project Repository: Url to the shared lib
+        * Credentials: SSH key to access the repo
+
+Note that updating the shared repo will take affect on the next pipeline invocation.
+*/ 
+
+// Load the get_vbu_version function from vivarium_build_utils/bootstrap/
+// (the directory to load from is defined in the Jenkins shared library configuration)
+@Library("get_vbu_version@main") _
+
+// Load the full vivarium_build_utils library at the expected version
+library("vivarium_build_utils@${get_vbu_version()}")
+
 reusable_pipeline(
     scheduled_branches: ["main"], 
     upstream_repos: ["vivarium", "layered_config_tree"],

Makefile

@@ -3,11 +3,12 @@ ifdef JENKINS_URL
 	# Files are already in workspace from shared library
 	MAKE_INCLUDES := .
 else
-	# For local dev, search in parent directory
-	MAKE_INCLUDES := ../vivarium_build_utils/resources/makefiles
+	# For local dev, use the installed vivarium_build_utils package
+	MAKE_INCLUDES := $(shell python -c "from vivarium_build_utils.resources import get_makefiles_path; print(get_makefiles_path())")
 endif
 
 PACKAGE_NAME = vivarium_cluster_tools
 
+# Include makefiles from vivarium_build_utils
 include $(MAKE_INCLUDES)/base.mk
 include $(MAKE_INCLUDES)/test.mk

setup.py

@@ -42,6 +42,7 @@
         long_description = f.read()
 
     install_requires = [
+        "vivarium_build_utils>=1.1.0,<2.0.0",
         "pandas",
         "numpy<2.0.0",
         "tables",