From 1ba91a85c74b50d867e43e304305c709eb1f282b Mon Sep 17 00:00:00 2001 From: vista Date: Thu, 23 Mar 2023 22:17:43 +0100 Subject: [PATCH] Update 'README.md' --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1a4e6c..b49f690 100644 --- a/README.md +++ b/README.md @@ -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
this is only requered of private repos +| REGISTRY_PASSWORD | the password for logging in into the registry
(*you probaly want to use a token here*) +| REGISTRY_API | the type of registry valid options are `docker` and `gitea`
Default: `docker` +| REGISTRY_URL | the url to the registry
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
(*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