vista/container-update-checker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Update 'README.md'
All checks were successful
ci/woodpecker/push/build Pipeline was successful
Details

Browse Source
This commit is contained in:
vista
2023-03-12 12:38:15 +01:00
parent b7b4b734be
commit 884ebcd21e
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,4 +1,20 @@
# container-update-checker
[![status-badge](https://woodpecker.narvas.tech/api/badges/vista/container-update-checker/status.svg)](https://woodpecker.narvas.tech/vista/container-update-checker)
check if a container needs rebuilding
[![status-badge](https://woodpecker.narvas.tech/api/badges/vista/container-update-checker/status.svg)](https://woodpecker.narvas.tech/vista/container-update-checker)
## Environment variables
| Name | Requered | Comment
|-----------------|---------------------------------|---------
| BASE | Yes | the image the Dockerfile is based on
| TARGET | Yes | the image thats based of `$BASE`
| DOCKER_USERNAME | No<br>*used for private images* | the username for logging in into docker hub
| DOCKER_PASSWORD | No<br>*used for private images* | the password for logging in into docker hub<br>(*you probaly want to use a token here*)
## Exit codes
| State | Exit code | Comment
|---------------------------------|-----------|--------
| BASE is more recent than TARGET | 0 | An update is needed
| TARGET is more recent than BASE | 1 | No update is needed<br>(*the pipeline wil "fail" but that is wat we want* )
| An error occured | 0 | So the pipeline can continue