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/pr/build Pipeline was successful
Details

Browse Source
This commit is contained in:
vista
2023-03-23 22:17:43 +01:00
parent f00364177f
commit 1ba91a85c7
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,4 +1,31 @@
# 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 | Comment
|-------------------|-----------
| BASE | the image the Dockerfile is based on
| TARGET | the image thats based of `BASE`
| REGISTRY_USERNAME | the username for logging in into the registry<br>this is only requered of private repos
| REGISTRY_PASSWORD | the password for logging in into the registry<br>(*you probaly want to use a token here*)
| REGISTRY_API | the type of registry valid options are `docker` and `gitea`<br>Default: `docker`
| REGISTRY_URL | the url to the registry<br>Default: `https://hub.docker.com`
| BASE_REGISTRY_USERNAME | if left empty `REGISTRY_USERNAME` is used
| BASE_REGISTRY_PASSWORD | if left empty `REGISTRY_PASSWORD` is used
| BASE_REGISTRY_API | if left empty `REGISTRY_API` is used
| BASE_REGISTRY_URL | if left empty `REGISTRY_URL` is used
| TARGET_REGISTRY_USERNAME | if left empty `REGISTRY_USERNAME` is used
| TARGET_REGISTRY_PASSWORD | if left empty `REGISTRY_PASSWORD` is used
| TARGET_REGISTRY_API | if left empty `REGISTRY_API` is used
| TARGET_REGISTRY_URL | if left empty `REGISTRY_URL` is used
## 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