Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whoan committed Nov 6, 2019
1 parent a09bf2a commit be6996a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ By default it pushes the image with all the stages to a registry, but you can di

None

## How it works

The action does the following every time it is triggered:

- Pull previously pushed [stages](https://docs.docker.com/develop/develop-images/multistage-build/) (if any) from the specified `registry` (default: https://hub.docker.com)
- Build the image using cache (ie: using the pulled stages)
- Push each stage of the built image to the registry with the name `<image_name>-stages:<1,2,3,...>`
- Push the image itself like `<image_name>:<image_tag>`
- Push any git tag if available like `<image_name>:<git_tag>`

## Example usage

Minimal example:
Expand Down

0 comments on commit be6996a

Please sign in to comment.