Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add directions to playbook for Science Pipelines quick-builds #242

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add directions to playbook for Science Pipelines quick-builds #242

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b37ec0e
Add directions to playbook for Science Pipelines quick-builds
eigerx Dec 6, 2024
b3e5bcd
Fix numbering for Release Management playbook section
eigerx Dec 6, 2024
62e1136
Small edits to playbook formatting, for clarity
eigerx Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 22 additions & 12 deletions doc/playbook.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,18 @@ Containers
==========

The service consists of two containers.
The first is a base container with the Science Pipelines "stack" code and networking utilities.
The second is a service container made from the base that has the Prompt Processing service code.
The first is a **base container** with the Science Pipelines "stack" code and networking utilities.
The second is a **service container** made from the base that has the Prompt Processing service code.
All containers are managed by `GitHub Container Registry <https://github.com/orgs/lsst-dm/packages?repo_name=prompt_processing>`_ and are built using GitHub Actions.

To build the base container:

* If there are changes to the container, push them to a branch, then open a PR.
The container should be built automatically.
* 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, select the branch whose container definition will be used, and the label of the Science Pipelines container.
This will build the container automatically.
* 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:

#. The branch whose container definition will be used
#. The label of the Science Pipelines container.
Copy link
Member

@kfindeisen kfindeisen Dec 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to include an entry for the science pipelines container (possibly adding it on commit "Add directions to playbook..."?) AFAICT that's the step you and Erin missed over the weekend.

* 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).
For automatic ``main`` builds, or if the corresponding box in the manual build is checked, the new container also has the ``latest`` label.
Containers built from a branch use the same scheme, but prefixed by the ticket number or, for user branches, the branch topic.
Expand All @@ -44,14 +46,16 @@ To build the base container:
To build the service container:

* If there are changes to the service, push them to a branch, then open a PR.
The container should be built automatically using the ``latest`` base container.
* To force a rebuild manually, go to the repository's `Actions tab <https://github.com/lsst-dm/prompt_processing/actions/workflows/build-service.yml>`_ and select "Run workflow".
This will build the container automatically using the ``latest`` base container.
* To force a rebuild manually, go to the repository's `Actions tab <https://github.com/lsst-dm/prompt_processing/actions/workflows/build-service.yml>`_ and select "**Run workflow**".
From the dropdown, select the branch whose code should be built.
The container will be built using the ``latest`` base container, even if there is a branch build of the base.
* To use a base other than ``latest``, edit ``.github/workflows/build-service.yml`` on the branch and override the ``BASE_TAG_LIST`` variable.
Be careful not to merge the temporary override to ``main``!
By default, the container is built using the ``latest`` base container, even if there is a branch build of the base.

* If this is the desired base container, no action is necessary.
* To use a base other than ``latest``, edit ``.github/workflows/build-service.yml`` on the branch and override the ``BASE_TAG_LIST`` variable.
Be careful not to merge the temporary override to ``main``!
* New service containers built from ``main`` have the tags of their base container.
Containers built from a branch are prefixed by the ticket number or, for user branches, the branch topic.
Containers built from a branch should be prefixed by the ticket number or, for user branches, the branch topic.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand this rewording. Have you seen cases where this doesn't happen (if so, that's a bug in the script)?


.. note::

Expand Down Expand Up @@ -110,6 +114,10 @@ Please note that the tag does not include a ``v`` at the beginning.

#. Choosing the Version Number

The first step in making a release is choosing an appropriate version number to describe it. This subsection offers guidance on this choice, as well as on differentiating between major and minor releases.

**To see which changes have occurred since the last release:**

On GitHub.com, navigate to the main page of the repository.
To the right of the list of files, click the latest release.
At the top of the page, click **## commits to main since this release**.
Expand All @@ -120,6 +128,8 @@ Please note that the tag does not include a ``v`` at the beginning.
In practice, almost any Science Pipelines update is at least a minor version, because new features are added constantly.
In the future, there may be "patched weekly" builds, which would justify a patch version of Prompt Processing.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could swear we removed this line, but now it should probably refer to quick-stack.


**Guidance on designating major releases:**

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see what you're trying to do, but I think this header would just be more confusing to someone who isn't trying to make a major release. The root problem is that, with the various additions, our actual versioning policy ("Release tags are semantic version identifiers following the pep 440 specification") has moved too far away from the description of the decision-making rules (they're not just guidelines -- compatibility is serious business!)

I think the best solution is to rearrange the existing text (and, if it still needs a header, make it something more generic like "Release types"). There's a lot of interdependency, though; my best idea so far is to move the compatibility rules/API definition out of the list entirely (to right after we say we use semantic versioning), and have item 1 focus entirely on the mechanics of tracking changes. What do you think?

For the ``prompt_processing`` service, a new major version is triggered by any of the following:

* Incompatibility with old fanned-out ``nextVisit`` messages (almost any change to ``Visit`` qualifies)
Expand All @@ -142,7 +152,7 @@ Please note that the tag does not include a ``v`` at the beginning.

Select **Generate Release Notes**.
This will generate a list of commit summaries and of submitters.
Add text as follows.
Add text as follows:

* Any specific motivation for the release (for example, including a specific feature, preparing for a specific observing run)
* Science Pipelines version and rubin-env version
Expand Down
Loading