Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rusowyler committed Dec 27, 2021
1 parent 36a3be5 commit bb8bfbd
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

Useful to push images updates to a master repository containing central manifests.

### When to use it?

If you are using Kubernetes, usually, after building and pushing a Docker image to it's registry
you will probably need to push that new tag to the repository that has all your manifest.

### Flow:

- Clones the central repository
- Runs: kustomize edit set image
- Pushes the resulted manifest to the central repository

There are different variables to setup the action:

## Inputs
Expand Down Expand Up @@ -78,3 +89,8 @@ Then make the token available to the Github Action following the steps:
user-email: [email protected]
directory: enviroment/qa
```
## TODO:
- Add real world examples
- Add a working example

0 comments on commit bb8bfbd

Please sign in to comment.