Publish a release

How a version tag publishes your product's images to Docker Hub.

You need the release pipeline set up as the CI guide ↗ (on GitHub) says, and IMAGE_PREFIX set in .woodpecker/release.yml ↗ (on GitHub).

Make your Docker Hub repositories private, unless the product is open source. A new Docker Hub repository is public unless the account says otherwise, and the API image holds the whole source tree, not only the build output.

Make <IMAGE_PREFIX>-base, -api, -spa and -mpa private, or set the account's default visibility to private, before the first tag.

1. Switch to main and pull. The tag must point at a commit on main:

   git switch main && git pull --ff-only
   

2. Tag the release:

   git tag v1.2.3
   

3. Push the tag:

   git push origin v1.2.3
   

The pipeline publishes <IMAGE_PREFIX>-api, -spa and -mpa. The worker runs the API image. It refuses a tag whose commit is not on main.

A tag such as v1.2.3-rc.1 publishes that tag only, never latest.

• Deploy an update
• The CI guide ↗ (on GitHub)