Skip to content

Fix broken README instructions and document optional inputs - #29

Open
ericof wants to merge 5 commits into
mainfrom
readme-fixes
Open

ericof wants to merge 5 commits into
mainfrom
readme-fixes

Conversation

@ericof

@ericof ericof commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

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

  • Workflows live in .github/workflows, not .github/actions.
  • The docker run example had no \ continuations, so it could not be pasted.
  • REGISTRY=hub.docker.com is not a registry endpoint (/v2/ answers 404 with no registry headers). Use docker.io.
  • GitLab example: .gitlab-cy.yml → .gitlab-ci.yml, and varibles: → variables: (GitLab rejects the unknown key). The dind service moves from 20.10.16 to 29, matching the image's Docker major.

Structure and accuracy

  • "A note on whitespace" was nested under "Configuration options" because of a merge artifact. It is a top-level section again.
  • The registry table row had four columns instead of five.
  • Credits now describe docker-stack-wait as a maintained fork included in this repository.
  • Typo and spacing fixes.

New documentation

  • A Prerequisites section.
  • deploy_timeout, resolve_image, prune and scale_after now have explanations and examples. scale_after needs the full <stack>_<service> name, because the value goes straight to docker service scale.
  • Registry login is skipped when username or password is empty.

Every behaviour described is taken from action.yml and scripts/docker-entrypoint.sh. make lint and make test pass.

ericof added 5 commits October 2, 2026 10:10
- 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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant