Fix syntax and updated release tag wording to not include v.

lsst-dm · Feb 13, 2024 · 3fa0772 · 3fa0772
1 parent cb72060
commit 3fa0772
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/playbook.rst b/doc/playbook.rst
@@ -71,14 +71,14 @@ Release Management
 
 Releases are largely automated through GitHub Actions (see the `ci-release.yaml <https://github.com/lsst-dm/prompt_processing/actions/workflows/ci-release.yaml>`  workflow file for details). When a semantic version tag is pushed to GitHub, Prompt Processing Docker images are published on GitHub and Docker Hub with that version.
 
-Regular releases happen from the ``main`` branch after changes have been merged.  From the ``main`` branch you can release a new major version (``X.0.0``), a new minor version of the current major version (``X.Y.0``), or a new patch of the current major-minor version (``X.Y.Z``).  Release tags are semantic version identifiers following the `pep 440 <https://peps.python.org/pep-0440/>` specification.
+Regular releases happen from the ``main`` branch after changes have been merged.  From the ``main`` branch you can release a new major version (``X.0.0``), a new minor version of the current major version (``X.Y.0``), or a new patch of the current major-minor version (``X.Y.Z``).  Release tags are semantic version identifiers following the `pep 440 <https://peps.python.org/pep-0440/>` specification.  Please note that the tag does not include a ``v`` at the beginning.
 
 1. Create a Release
 
 On GitHub.com, navigate to the main page of the repository.  To the right of the list of files, click **Releases**.  At the top of the page, click **Draft a new release**.  Type a tag using semantic versioning described in the previous section.  The Target should be the main branch.
 
 Select **Generate Release Notes**.  This will generate a list of commit summaries and of submitters.   Add text as follows.
-* Any specific motivation for the release(for example, including a specific feature, preparing for a specific observing run))
+* 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
 * Any changes to the APDB and Alerts schemas