From 0d9656f60a53a2907c011839c7f909dd656031c9 Mon Sep 17 00:00:00 2001 From: teutat3s Date: Sat, 18 Nov 2023 20:35:37 +0100 Subject: [PATCH] docs: update README with CI docs --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6fc2ccc..2224054 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ # Mediawiki docker image with OIDC extension -### Quick start +### Updating the docker image +After making your changes and [testing them locally](#local-testing), run the +following to trigger a [CI build and push](https://git.pub.solar/pub-solar/mediawiki-oidc-docker/actions) +of the [docker image](https://git.pub.solar/pub-solar/mediawiki-oidc-docker/packages). ``` -docker build --tag git.pub.solar/pub-solar/mediawiki-oidc-docker:latest . - -docker login git.pub.solar - -docker push git.pub.solar/pub-solar/mediawiki-oidc-docker:latest +git add -u +git commit +git push ``` +### Local testing +Build the docker image locally to test your changes. +``` +docker build --tag git.pub.solar/pub-solar/mediawiki-oidc-docker:test . +``` + + ### Links - https://github.com/wikimedia/mediawiki-docker - https://www.mediawiki.org/wiki/Extension:OpenID_Connect