Fix broken README instructions and document optional inputs - #29
Merged
Merged
Conversation
- Fix `.github/actions` to `.github/workflows` in GitHub Action usage instructions - Add line continuations to docker run example so it can be pasted as a shell command - Change registry from `hub.docker.com` to `docker.io` (correct Docker API endpoint) - Fix typo `.gitlab-cy.yml` to `.gitlab-ci.yml` - Fix typo `varibles` to `variables` in GitLab CI example - Update outdated docker:20.10.16-dind to docker:26-dind - Adjust "A note on whitespace" section from ### to ## level (was incorrectly nested under Configuration options table)
- Fix registry input table to have consistent column count (add missing default value column) - Fix "on the the machine" typo to "on the machine" - Add blank line before License section for better readability - Update Credits section to accurately describe docker-stack-wait as a maintained fork rather than external script
…ites - Add Prerequisites section explaining Docker Swarm, SSH setup, and Docker group requirements - Add Optional Parameters section with detailed explanations for deploy_timeout, resolve_image, prune, and scale_after - Document that registry login is skipped when credentials are not provided - Include practical examples for each optional parameter showing real-world usage
docker service scale needs the full Swarm service name, which is prefixed with the stack name, so the bare service names in the example would fail. The GitLab example now uses the same Docker major as the image (29).
davisagli
approved these changes
Oct 3, 2026
| | GitHub Action Input | Environment Variable | Summary | Required | Default Value | | ||
| | --- | --- | --- | --- | --- | | ||
| | `registry` | `REGISTRY` | Specify which container registry to login to. | | | ||
| | `registry` | `REGISTRY` | Specify which container registry to login to. | | | |
Member
There was a problem hiding this comment.
Can we mention the right values for common options like DockerHub and GHCR here? I was trying to find them recently.
|
|
||
| ### `scale_after` | ||
|
|
||
| Scales a service to a specific number of replicas after a deployment has converged successfully. Useful when you want to adjust replica counts after initial deployment. |
Member
There was a problem hiding this comment.
Really the purpose of it is to scale up a one-off job that should only run after the deployment has converged (like a solr reindex)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes README errors that shipped in v1.5.0, several of which make the documented steps fail as written, and documents inputs that were only table rows.
Broken instructions
.github/workflows, not.github/actions.docker runexample had no\continuations, so it could not be pasted.REGISTRY=hub.docker.comis not a registry endpoint (/v2/answers 404 with no registry headers). Usedocker.io..gitlab-cy.yml→.gitlab-ci.yml, andvaribles:→variables:(GitLab rejects the unknown key). Thedindservice moves from20.10.16to29, matching the image's Docker major.Structure and accuracy
registrytable row had four columns instead of five.docker-stack-waitas a maintained fork included in this repository.New documentation
deploy_timeout,resolve_image,pruneandscale_afternow have explanations and examples.scale_afterneeds the full<stack>_<service>name, because the value goes straight todocker service scale.usernameorpasswordis empty.Every behaviour described is taken from
action.ymlandscripts/docker-entrypoint.sh.make lintandmake testpass.