Skip to content

Commit d6bb84a

Browse files
committed
Add directions to playbook for science pipelines quick-builds
1 parent 7dd8cf7 commit d6bb84a

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

doc/playbook.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,14 @@ All containers are managed by `GitHub Container Registry <https://github.com/org
2929
To build the base container:
3030

3131
* If there are changes to the container, push them to a branch, then open a PR.
32-
The container should be built automatically.
33-
* If there are no changes (typically because you want to use an updated Science Pipelines container), go to the repository's `Actions tab <https://github.com/lsst-dm/prompt_processing/actions/workflows/build-base.yml>`_ and select "Run workflow".
34-
From the dropdown, select the branch whose container definition will be used, and the label of the Science Pipelines container.
35-
* New containers built from ``main`` are tagged with the corresponding Science Pipelines release (plus ``w_latest`` or ``d_latest`` if the release was requested by that name).
32+
This will build the container automatically.
33+
* If there are no changes (typically because you want to use an updated Science Pipelines container), go to the repository's `Actions tab <https://github.com/lsst-dm/prompt_processing/actions/workflows/build-base.yml>`_ and select "**Run workflow**". From the dropdown menu, select:
34+
35+
#. The branch whose container definition will be used
36+
#. The label of the Science Pipelines container.
37+
#. If using a quick-stack build, the Science Pipelines Container should be set to `ghcr.io/lsst/quick-stack <https://ghcr.io/lsst/quick-stack>`_.
38+
39+
New containers built from ``main`` are tagged with the corresponding Science Pipelines release (plus ``w_latest`` or ``d_latest`` if the release was requested by that name).
3640
For automatic ``main`` builds, or if the corresponding box in the manual build is checked, the new container also has the ``latest`` label.
3741
Containers built from a branch use the same scheme, but prefixed by the ticket number or, for user branches, the branch topic.
3842

@@ -68,6 +72,12 @@ Any subsequent builds of the service container will build against both bases.
6872

6973
This is the only situation in which a change to ``BASE_TAG_LIST`` should be committed to ``main``.
7074

75+
It will sometimes be necessary to compile a container with the LSST Science Pipelines manually (called a Quick-Stack build).
76+
Generally, this only occurs if the intended daily or weekly stack does not compile.
77+
In these cases, the Science Pipelines themselves must be built ahead of the base container.
78+
Instructions for building the Science Pipelines are `here <https://github.com/lsst/gha_build/blob/main/README.md>`_.
79+
For Prompt Processing, we only need to build `lsst_distrib`.
80+
7181
Release Management
7282
==================
7383

0 commit comments

Comments
 (0)