add docker hub instructions to release template (#260)

sigp · Jul 11, 2024 · c9863f9 · c9863f9
1 parent 5bf76e5
commit c9863f9
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 21 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -62,9 +62,20 @@ jobs:
           ## Release Checklist (DELETE ME)
 
           - [ ] Merge `unstable` -> `stable`.
-          - [ ] Ensure docker images are published (check `latest` and the version tag).
+          - [ ] Ensure docker images are published to `sigp` namespace (instructions below)
           - [ ] Prepare Discord post.
 
+          Someone with appropriate access rights should run these commands:
+          0. sanity check: did the `docker` workflow complete correctly, are the images published under the `sigmaprime` namespace? 
+             see: https://hub.docker.com/r/${{ env.DOCKER_USERNAME }}/siren/tags?name=${{ env.VERSION }} and https://hub.docker.com/r/${{ env.DOCKER_USERNAME }}/siren/tags?name=latest
+          1. publish `latest`: 
+             `docker manifest create sigp/siren:latest --amend sigmaprime/siren:latest-amd64 --amend sigmaprime/siren:latest-arm64`
+             `docker manifest push sigp/siren:latest`
+          2. publish `${{ env.VERSION }}`:
+             `docker manifest create sigp/siren:${{ env.VERSION }} --amend sigmaprime/siren:${{ env.VERSION }}-amd64 --amend sigmaprime/siren:${{ env.VERSION }}-arm64`
+             `docker manifest push sigp/siren:${{ env.VERSION }}`
+          3. verify: https://hub.docker.com/r/siren/siren/tags?name=${{ env.VERSION }} and https://hub.docker.com/r/sigp/siren/tags?name=latest
+
           ## Summary
 
           Add a summary.
@@ -83,7 +94,7 @@ jobs:
           ${{ steps.changelog.outputs.CHANGELOG }}
 
           ## Docker Hub
-          https://hub.docker.com/r/${{ env.DOCKER_USERNAME }}/siren/tags?name=${{ env.VERSION }}
+          https://hub.docker.com/r/sigp/siren/tags?name=${{ env.VERSION }}
 
           ENDBODY
           )

diff --git a/Makefile b/Makefile
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -6,3 +6,6 @@ services:
 #      - "4080:80"  # uncomment this line when using `SSL_ENABLED=false`
     env_file:
       - .env
+#    uncomment these 2 lines if you use docker on linux and want to use the special host `host.docker.internal` as your BN/VC address
+#    extra_hosts:
+#      - "host.docker.internal:host-gateway"