fix: Docker image steps in documentation + limit latest tag to valid Semver git tags (e.g. v0.11.8) (#1349)

* fix: Limit `latest` Docker tag to valid Semver git tags (e.g. v0.1.0)

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

* fix: Docker tags (`latest`)

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

* fix: Docker tags (`latest`)

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

* fix: docker.yaml (`latest` tag)

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

* fix: Docker `latest` tag

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

* fix: Docker docs

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

---------

Signed-off-by: Liam Beckman <lbeckman314@gmail.com>

Author: lbeckman314

.github/workflows/docker.yaml

@@ -104,10 +104,24 @@ jobs:
           images: |
             ${{ env.QUAY_REPO }}
           tags: |
-            type=ref,event=branch
-            type=ref,event=pr
-            type=ref,event=tag
-            type=sha,prefix=
+            # Semver tag
+            # Ref: https://github.com/docker/metadata-action/tree/v5#typesemver
+            type=semver,pattern={{version}},value=${{ github.ref_name }}
+
+            # Latest tag
+            type=raw,value=latest,enable=${{ github.ref_name != '' && !contains(github.ref_name, '-') }}
+
+            # Branch
+            type=ref,event=branch,latest=false
+
+            # PR
+            type=ref,event=pr,latest=false
+
+            # Git tag
+            type=ref,event=tag,latest=false
+
+            # SHA
+            type=sha,prefix=,latest=false
 
       - name: Create manifest list and push
         working-directory: ${{ runner.temp }}/digests

.github/workflows/hugo.yaml

@@ -54,6 +54,7 @@ jobs:
       - name: Build site with Hugo
         run: |
           make website
+          cp install.sh ./docs/install.sh
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

install.sh

@@ -11,6 +11,8 @@ show_help() {
 	echo "  $0 [version] [install_path]  # Install Funnel (default: latest version to \$HOME/.local/bin)"
 	echo "  $0 --list                    # List available versions"
 	echo "  $0 --help                    # Show this help"
+	echo "  $0 --version <version>       # Specify version to install"
+	echo "  $0 --dest <install_path>     # Specify installation path (default: \$HOME/.local/bin)"
 }
 
 list_tags() {

website/content/development/developers.md

@@ -17,7 +17,7 @@ This page contains a rough collection of notes for people wanting to build Funne
 2. Ensure GOPATH is set. See [the docs][gopath] for help. Also, you probably want to add `$GOPATH/bin` to your `PATH`.
 3. Clone funnel and build
 
-	```shell
+	```sh
 	$ git clone https://github.com/ohsu-comp-bio/funnel.git
 	$ cd funnel
 	$ make

website/content/docs/databases/datastore.md

@@ -38,7 +38,7 @@ to support the task-list queries.
 This is typically done through command-line by referencing an **index.yaml**
 file (do not change the filename) with the following content:
 
-```shell
+```sh
 gcloud datastore indexes create path/to/index.yaml --database='funnel'
 ```
 

website/content/docs/development/developers.md

@@ -17,7 +17,7 @@ This page contains a rough collection of notes for people wanting to build Funne
 2. Ensure GOPATH is set. See [the docs][gopath] for help. Also, you probably want to add `$GOPATH/bin` to your `PATH`.
 3. Clone funnel and build
 
-	```shell
+	```sh
 	$ git clone https://github.com/ohsu-comp-bio/funnel.git
 	$ cd funnel
 	$ make

website/content/download.md

@@ -19,6 +19,10 @@ menu:
 [releases]: https://github.com/ohsu-comp-bio/funnel/releases/latest
 [windows]: https://github.com/ohsu-comp-bio/funnel/issues/1258
 
+> [!NOTE]
+>
+>Funnel requires that [Docker](https://docker.io) be installed in order to run commands within a sandboxed environment.
+
 # Install Options
 
 - [Quick Start (curl one-liner)](#quick-start)
@@ -30,12 +34,10 @@ menu:
 
 ## 1. Quick Start
 
-The following command will automatically download and verify the latest version of Funnel for your operating system.
-
-Funnel requires that [Docker](https://docker.io) be installed in order to run commands within a sandboxed environment.
+The following [install script](https://github.com/ohsu-comp-bio/funnel/blob/develop/website/static/install.sh) will automatically download and verify the latest version of Funnel for your operating system:
 
-```shell
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ohsu-comp-bio/funnel/refs/heads/develop/install.sh)"
+```sh
+/bin/bash -c "$(curl -fsSL https://ohsu-comp-bio.github.io/funnel/install.sh)"
 
 funnel server run
 ```
@@ -44,39 +46,28 @@ funnel server run
 
 The following commands show examples of running Funnel via Docker, Podman, and Singularity.
 
-Each command demonstrates how to mount an optional example config (`example.yaml`) for use by the Funnel Server.
+Each command demonstrates how to mount an optional example config (`config.yaml`) for use by the Funnel Server.
 
-```yaml
-# example.yaml ➜ local Funnel Server config
-Database: boltdb
-
-Compute: local
-
-Logger:
-  Level: debug
-```
-
-> [!WARNING]
+> [!TIP]
 > When given no config, Funnel will simply run in the default "local" mode.
 > 
 > This can be helpful for testing and development, but production deployments are recommended to use the more robust database and compute backends available.
 
-
 ### Docker
 
 > [!TIP]
 >
 > Docker Image → [quay.io/repository/ohsu-comp-bio/funnel:latest](https://quay.io/repository/ohsu-comp-bio/funnel?tab=tags&tag=testing)
 
-```shell
-docker run -p 8000:8000 -v example.yaml:/example.yaml quay.io/ohsu-comp-bio/funnel:latest server run --config /example.yaml
+```sh
+docker run -p 8000:8000 quay.io/ohsu-comp-bio/funnel:latest server run
+```
+
+To run Funnel with a custom config file (e.g. `config.yaml`), pass it via a Docker volume:
 
-curl localhost:8000/service-info
-# {
-#   "description": "Funnel is a toolkit for distributed task execution via a simple, standard API.",
-#   "documentationUrl": "https://ohsu-comp-bio.github.io/funnel/",
-#   ...
-# }
+```sh
+docker run -p 8000:8000 -v ./config.yaml:/config.yaml \
+    quay.io/ohsu-comp-bio/funnel:latest server run --config /config.yaml
 ```
 
 ### Podman
@@ -85,14 +76,14 @@ curl localhost:8000/service-info
 >
 > [Podman: Running a container](https://podman.io/docs#running-a-container)
 
-```shell
+```sh
 podman machine init
 # Machine init complete
 
 podman machine start
 # Machine "podman-machine-default" started successfully
 
-podman run -p 8000:8000 -v ./example.yaml:/example.yaml quay.io/ohsu-comp-bio/funnel:latest server run --config /example.yaml
+podman run -p 8000:8000 -v ./config.yaml:/config.yaml quay.io/ohsu-comp-bio/funnel:latest server run --config /config.yaml
 # {"httpPort": "8000", "msg": "Server listening", "rpcAddress": ":9090"}
 ```
 
@@ -102,8 +93,8 @@ podman run -p 8000:8000 -v ./example.yaml:/example.yaml quay.io/ohsu-comp-bio/fu
 >
 > [Singularity and Docker](https://docs.sylabs.io/guides/2.6/user-guide/singularity_and_docker.html)
 
-```shell
-singularity run --bind example.yaml:/example.yaml docker://quay.io/ohsu-comp-bio/funnel:latest server run --config /example.yaml
+```sh
+singularity run --bind config.yaml:/config.yaml docker://quay.io/ohsu-comp-bio/funnel:latest server run --config /config.yaml
 # INFO:    Converting OCI blobs to SIF format
 # INFO:    Starting build...
 # INFO:    Creating SIF file...
@@ -118,7 +109,7 @@ singularity run --bind example.yaml:/example.yaml docker://quay.io/ohsu-comp-bio
 >
 > Homebrew formula source available at [github.com/ohsu-comp-bio/homebrew-formula](https://github.com/ohsu-comp-bio/homebrew-formula)
 
-```shell
+```sh
 brew tap ohsu-comp-bio/formula
 
 brew install funnel
@@ -130,7 +121,7 @@ brew install funnel
 >
 > Funnel requires a recent version of Go. See [development docs](../development/developers/) for more detail.
 
-```shell
+```sh
 git clone https://github.com/ohsu-comp-bio/funnel.git
 
 cd funnel