changing which lines are commented out by default

.github/workflows/publish.yml

@@ -4,24 +4,24 @@ jobs:
   test:
     uses: ./.github/workflows/ci.yml
 
-  publish:
-    runs-on: ubuntu-latest
-    needs: test
-    # Uncomment the following steps to build a Docker image and publish to the GitHub container registry on release. Alternatively, can replace with other publising steps (ie. publishing to PyPI, deploying documentation etc.)
-    # steps:
-    #   - name: Login to GitHub Container Registry
-    #     uses: docker/login-action@v3
-    #     with:
-    #       registry: ghcr.io
-    #       username: ${{ github.actor }}
-    #       password: ${{ secrets.GITHUB_TOKEN }}
-    #   - name: Get image metadata
-    #     id: meta
-    #     uses: docker/metadata-action@v5
-    #     with:
-    #       images: ghcr.io/${{ github.repository }}
-    #   - name: Build and push Docker image
-    #     uses: docker/build-push-action@v5
-    #     with:
-    #       push: true
-    #       tags: ${{ steps.meta.outputs.tags }}
+  # publish:
+  #   runs-on: ubuntu-latest
+  #   needs: test
+  #   # The following steps to build a Docker image and publish to the GitHub container registry on release. Alternatively, can replace with other publising steps (ie. publishing to PyPI, deploying documentation etc.)
+  #   steps:
+  #     - name: Login to GitHub Container Registry
+  #       uses: docker/login-action@v3
+  #       with:
+  #         registry: ghcr.io
+  #         username: ${{ github.actor }}
+  #         password: ${{ secrets.GITHUB_TOKEN }}
+  #     - name: Get image metadata
+  #       id: meta
+  #       uses: docker/metadata-action@v5
+  #       with:
+  #         images: ghcr.io/${{ github.repository }}
+  #     - name: Build and push Docker image
+  #       uses: docker/build-push-action@v5
+  #       with:
+  #         push: true
+  #         tags: ${{ steps.meta.outputs.tags }}

README.md

@@ -83,4 +83,5 @@ for this are:
 
 ### Publishing
 
-The GitHub workflow includes an action to publish on release (`publish.yml`). Add steps where indicated to publish a Docker image, PyPI package, documentation, etc.
+The GitHub workflow includes an action to publish on release.
+To run this action, uncomment the commented portion of `publish.yml`, and modify the steps for the desired behaviour (publishing a Docker image, publishing to PyPI, deploying documentation etc.)