From 3331cf5e8e0da4f2b9509304e0ed2dbbfc92caf8 Mon Sep 17 00:00:00 2001 From: Carl-Erik Kopseng Date: Tue, 9 Nov 2021 09:06:24 +0100 Subject: [PATCH] Describe example with volume mount The examples are a bit too brief: this adds some context. would have closed #28 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index eab5a93..36e55b2 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ #### Typical Use Case +Here we mount a volume under `/work` and specify an environment variable. This is the equivalent of `docker run --rm -v ${{ github.workspace }}:/work -e ABC=123 private-image:latest sh -c 'echo "Running script"; /work/run-script'. + ```yaml - name: Checkout uses: actions/checkout@v2 # Required to mount the Github Workspace to a volume