Bump an existing EasyBuild recipe¶
A bump is a canonical EasyBuild-origin package bundle. It emits a planned Software Bill of Materials (SBOM), a Resolvo lock, and a rewritten recipe; it does not use a separate text rewrite API.
Retarget the toolchain generation¶
eb-stack package bump \
--source tests/repro_fixtures/gromacs/GROMACS-2024.4-foss-2023b.eb \
--toolchain foss/2024a \
--easyconfigs tests/repro_fixtures/universe_foss_2024a \
--out-dir /tmp/eb-stack/bundles/gromacs-2024a
The solver materializes the source recipe as a default profile, derives the target toolchain hierarchy from the robot tree, and asks Resolvo for a jointly feasible dependency selection. Existing robot artifacts keep independent build-tool scopes, matching EasyBuild’s installed-module model.
A dependency’s versionsuffix, as in ('HDF5', '1.14.2', '-mpi'), holds
wherever the robot tree has a build with that suffix the solve can take,
so the bump does not trade -mpi for -serial. Only when the target has
no such build does the solve take another suffix: a library’s
-CUDA-12.9.1 build becomes its -CUDA-13.3.0 build when the target
generation carries only that one.
The output is:
/tmp/eb-stack/bundles/gromacs-2024a/
package.plan.json
package.sbom.cdx.json
locks/default.lock.json
easyconfigs/g/GROMACS/GROMACS-2024.4-foss-2024a.eb
Use site overlays and stack preferences¶
Pass robot paths from general to specific. An explicit override is a
locked solver input. This fixture’s universe already selects Python
3.12.3, and --dep records that pin:
eb-stack package bump \
--source tests/repro_fixtures/gromacs/GROMACS-2024.4-foss-2023b.eb \
--toolchain foss/2024a \
--easyconfigs tests/repro_fixtures/universe_foss_2024a \
--dep Python=3.12.3 \
--out-dir /tmp/eb-stack/bundles/gromacs-dep
Preferred distribution pins participate in the Boolean satisfiability (SAT) solve and may fall back. Locked pins are exact constraints. Both outcomes are recorded in the profile lock, so a site preference never becomes an invisible post-solve edit. When a selected pin belongs to another toolchain generation, the emitted dependency tuple includes that toolchain explicitly. Source dependencies that already use an explicit toolchain preserve their family and retarget its generation before solving.
Change the application version¶
eb-stack package bump \
--source tests/repro_fixtures/gromacs/GROMACS-2024.4-foss-2023b.eb \
--toolchain foss/2024a \
--version 2024.5 \
--easyconfigs tests/repro_fixtures/universe_foss_2024a \
--out-dir /tmp/eb-stack/bundles/gromacs-2024.5
The emitter updates the package version, target toolchain, selected dependency
versions, conventional filename, and source checksum entry. A [package] version in a package-config layer moves the version the same way, and
--version wins when both are given. The emitted recipe is the plan’s
default profile, so a layer that makes gpu the default emits that
profile. A dependency stated in both dependencies and
builddependencies is rewritten when either line disagrees with the lock.
A dependency that spells the module, ('OpenMPI', '5.0.3-GCC-13.3.0'), is
an exact pin on that build, from a SYSTEM recipe too; only an exact pin
reads the module or suffix spelling, a range such as <5 compares versions.
Patches remain explicit review work. Omitting the new checksum clears the
old digest to an empty string and records a residual. The bump never
invents a digest.
When the tree already has a recipe for the new version under another
toolchain, its patches and checksums blocks are adopted and the plan’s
patch set is rebuilt from them; the first source digest stays what the bump
wrote, the --source-checksum value or the cleared slot. A vanished
dependency is removed wherever its tuple sits on the line. With
local_host_arch, local_order and local_equations in
[build.easyconfig_parameters] and the matching -DHOST_ARCH, -DORDER
and -DEQUATIONS flags in config_options, the bump derives
local_binary and parameterises configopts and the sanity paths on those
locals, the SeisSol shape.
To fill the digest without a separate EasyBuild run, pass --fetch-checksums.
The bump resolves sources and source_urls at the new version, downloads
each entry from those URLs in order, and writes the first source’s SHA-256 into
the recipe and the SBOM, matching what eb --inject-checksums does on the
EasyBuild host. A git checkout, a missing URL or a failed download stays empty
and is listed in sources.fetch.json and as a source:fetch residual:
eb-stack package bump \
--source tests/repro_fixtures/gromacs/GROMACS-2024.4-foss-2023b.eb \
--toolchain foss/2024a \
--version 2024.5 \
--fetch-checksums \
--easyconfigs tests/repro_fixtures/universe_foss_2024a \
--out-dir /tmp/eb-stack/bundles/gromacs-fetch
The download fills gromacs-2024.5.tar.gz in checksums. The digest
written for that tarball is
fecf06b186cddb942cfb42ee8da5f3eb2b9993e6acc0a2f18d14ac0b014424f3.
With the source downloaded, the bump also tries every patch the tree cannot
decide against it, as EasyBuild’s patch step will. A patch that applies stays,
one the release already contains or whose files are gone leaves patches and
checksums, and one that conflicts stays as an undecided patch-decision
residual that names the failed hunks. Such a patch needs a version rebased on
the new release before the recipe builds.
Check and build¶
RECIPE=/tmp/eb-stack/bundles/gromacs-2024a/easyconfigs/g/GROMACS/GROMACS-2024.4-foss-2024a.eb
eb-stack recipe format "$RECIPE"
eb-stack recipe lint "$RECIPE"
eb-stack recipe check \
--recipe "$RECIPE" \
--easyconfigs tests/repro_fixtures/universe_foss_2024a \
--easyconfigs /tmp/eb-stack/bundles/gromacs-2024a/easyconfigs
mkdir -p /tmp/eb-stack/robot
rsync -a tests/repro_fixtures/universe_foss_2024a/ /tmp/eb-stack/robot/
podman build -t eb-stack-rocky9 \
-f skills/new-package/container/rocky9/Containerfile \
skills/new-package/container/rocky9
eb-stack campaign run \
--bundle /tmp/eb-stack/bundles/gromacs-2024a \
--config examples/targets/local-podman.toml \
--target local-rocky9 \
--state /tmp/eb-stack/bundles/gromacs-2024a.campaign.json
package bump can establish resolves. Only the campaign’s EasyBuild run can
establish builds, and only declared verification commands can establish
binary-verified. Follow skills/annual-bump/SKILL.md for batch operation and
repair handling. One generation of recipes is
the annual bump. The same GROMACS source bumped
to foss/2025b, with the SBOM recorded there, is in
dependency closure.