From 884ebcd21efbaa0b6197bd7dce905b7847d3d072 Mon Sep 17 00:00:00 2001 From: vista Date: Sun, 12 Mar 2023 12:38:15 +0100 Subject: [PATCH] Update 'README.md' --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1a4e6c..e11a667 100644 --- a/README.md +++ b/README.md @@ -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
*used for private images* | the username for logging in into docker hub +| DOCKER_PASSWORD | No
*used for private images* | the password for logging in into docker hub
(*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
(*the pipeline wil "fail" but that is wat we want* ) +| An error occured | 0 | So the pipeline can continue \ No newline at end of file