[dist] Allow tagging docker images as latest on dispatch

Author: Breakthrough

.github/workflows/docker-publish.yml

@@ -3,6 +3,11 @@ name: Publish Docker Image
 
 on:
   workflow_dispatch:
+    inputs:
+      tag_latest:
+        description: 'Also tag this build as `latest`'
+        type: boolean
+        default: false
   push:
     branches: [ "main" ]
   release:
@@ -47,6 +52,7 @@ jobs:
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
             type=sha
+            type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' && inputs.tag_latest }}
 
       - name: Build and push Docker image
         id: push

README.md

@@ -29,7 +29,7 @@
 
     pip install scenedetect --upgrade
 
-Requires ffmpeg/mkvmerge for video splitting support. Windows builds (MSI installer/portable ZIP) can be found on [the download page](https://scenedetect.com/download/).
+Requires ffmpeg/mkvmerge for video splitting support. Windows builds (MSI installer/portable ZIP) can be found on [the download page](https://scenedetect.com/download/). A Docker image with all dependencies included is available as [`ghcr.io/breakthrough/pyscenedetect`](https://github.com/Breakthrough/PySceneDetect/pkgs/container/pyscenedetect).
 
 ----------------------------------------------------------
 

website/pages/changelog.md

@@ -768,7 +768,11 @@ Development
 
  - [feature] Add `scenedetect-core`, a new library-only package with minimal dependencies (`numpy` only): it does not depend on any specific OpenCV variant, allowing downstream projects to choose their own (e.g. `opencv-contrib-python`), and does not include the CLI dependencies or the `scenedetect` command [#558](https://github.com/Breakthrough/PySceneDetect/issues/558). Convenience extras `scenedetect-core[opencv]` and `scenedetect-core[opencv-headless]` are provided
  - [general] `scenedetect` and `scenedetect-headless` are unchanged: they continue to ship the full program (library + CLI) with `opencv-python` / `opencv-python-headless` respectively. All three packages provide the same `scenedetect` module (install or depend only one)
- - [feature] Official Docker images are now published to the GitHub Container Registry: `docker run --rm ghcr.io/breakthrough/pyscenedetect` runs the full CLI with all backends and external tools (ffmpeg, mkvmerge) included, thanks [@FNGarvin](https://github.com/FNGarvin) [#537](https://github.com/Breakthrough/PySceneDetect/pull/537)
+ - [feature] Official Docker images are now published to the GitHub Container Registry with the full CLI, all backends, and external tools (ffmpeg, mkvmerge) included, thanks [@FNGarvin](https://github.com/FNGarvin) [#537](https://github.com/Breakthrough/PySceneDetect/pull/537)
+     - Example usage (process a video in the current directory):
+```bash
+docker run --rm -v "$(pwd):/files" ghcr.io/breakthrough/pyscenedetect -i /files/video.mp4 detect-adaptive split-video -o /files
+```
 
 #### General
 

website/pages/download.md

@@ -33,6 +33,24 @@ All three provide the same `scenedetect` Python module -- install only one of th
 <a href="../cli/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
 </div>
 
+## Docker Image &nbsp; <span class="wy-text-neutral"><span class="fa fa-ship"></span></span>
+
+Official container images are published at [ghcr.io/breakthrough/pyscenedetect](https://github.com/breakthrough/PySceneDetect/pkgs/container/pyscenedetect). The image includes the full CLI, all optional backends (PyAV, MoviePy), and the external tools used for video splitting (`ffmpeg`, `mkvmerge`) -- no other setup is required:
+
+```bash
+docker pull ghcr.io/breakthrough/pyscenedetect
+docker run --rm ghcr.io/breakthrough/pyscenedetect version
+```
+
+To process videos, mount the folder containing them into the container (the image runs as a non-root user, so output files are written with regular permissions):
+
+```bash
+docker run --rm -v "$(pwd):/files" ghcr.io/breakthrough/pyscenedetect \
+    -i /files/video.mp4 detect-adaptive split-video -o /files
+```
+
+The `latest` tag (the default when no tag is given) points to the most recent recommended build, and the `main` tag tracks the development branch. Starting with the next release, version tags (e.g. `0.7.1`) will also be published. `podman` can be used in place of `docker` in the commands above.
+
 ## Post Installation
 
 After installation, you can call PySceneDetect from any terminal/command prompt by typing `scenedetect` (try running `scenedetect --help`, or `scenedetect version`). If you encounter any runtime errors while running PySceneDetect, ensure that you have all the required dependencies listed in the System Requirements section above (you should be able to `import numpy` and `import cv2`).  If you encounter any issues or want to make a feature request, feel free to [report any bugs or share some feature requests/ideas](contributing.md) on the [issue tracker](https://github.com/Breakthrough/PySceneDetect/issues) and help make PySceneDetect even better.