review comments form Irfan

MDAnalysis · Sep 16, 2023 · 83bc45a · 83bc45a
1 parent b716c8a
commit 83bc45a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/gh-ci-tests.yaml b/.github/workflows/gh-ci-tests.yaml
@@ -45,7 +45,6 @@ jobs:
 
       - name: "test snapshots"
         working-directory: doc/source/scripts/
-        continue-on-error: true
         run: python -m pytest
 
       - name: "test notebooks"

diff --git a/doc/source/preparing_releases_and_hotfixes.rst b/doc/source/preparing_releases_and_hotfixes.rst
@@ -176,6 +176,13 @@ Create a release of the UserGuide
 
 For now, the UserGuide is released at the same time as the core library. To make a release of the UserGuide you should:
 
+#. Update the version of MDA used by the UserGuide to the release version.
+
+#. Re-generate the Syrup test snapshots, and commit those to git and confirm the build passes.
+
+    .. code-block:: bash
+        python -m pytest --snapshot-update
+
 #. Create a new release tag and upload them for the UserGuide repository.
 
     .. code-block:: bash