From 0ab0d34cd303529dbf54ddf8ead1065f97882c6f Mon Sep 17 00:00:00 2001 From: teutat3s Date: Thu, 7 Nov 2024 10:44:15 +0100 Subject: [PATCH] docs: update README --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58c51ea..5c52a60 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,23 @@ Docker image with all dependencies installed, configured to be as close to GitHub actions as possible. -The CI builds this image on pushes to `main` as `git.pub.solar/pub-solar/actions-base-image:20-bookworm`. +Creates a `ci` user with passwordless sudo to enable nix single-user install in +a `node:20-bookworm` base image. + +See this [GH issue](https://github.com/NixOS/nix/issues/1559) for additional +context. + + +### How to update the image + +On push to the `main` branch, a job will be triggered to build the image and +push it as `git.pub.solar/pub-solar/actions-base-image:20-bookworm`. + + +### Local testing Building the image locally: ``` docker build --tag git.pub.solar/pub-solar/actions-base-image:20-bookworm . ``` - -Creates a `ci` user with passwordless sudo to enable nix single-user install in a `node:20-bookworm` base image. - -See this [GH issue](https://github.com/NixOS/nix/issues/1559) for additional context.