From 3ff91d2f2d1b8d2c331588591ea363037a29e931 Mon Sep 17 00:00:00 2001 From: Tim Heuer Date: Wed, 1 Sep 2021 10:27:41 -0700 Subject: [PATCH] Updating documentation --- README.md | 2 +- package-lock.json | 2 +- package.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 004da06..105a1c3 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Use this action if you need to get a file from a base64-encoded string that you fileName: 'myTemporaryFile.txt' encodedString: ${{ secrets.SOME_ENCODED_STRING }} ``` - +By default this writes the `fileName` to a temporary path defined by `env.RUNNER_TEMP`. If you want a different path that is writable, specify `fileDir` as an input argument as well and then `fileDir` and `fileName` will be combined to create the path where the output will be written. This assumes permissions in the `fileDir` are correct and does not try to set them. ## Using the file in a later step The Action has an output variable named filePath that you can use as this file is written to TEMP. Make sure you ad an `id` to your step when using this Action so that you can easily pull it out of the steps context later. diff --git a/package-lock.json b/package-lock.json index c26b48b..5357e07 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "base64-to-file", - "version": "1.0.0", + "version": "1.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 2d6cf9a..d9b77d4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "base64-to-file", - "version": "1.0.0", + "version": "1.1.0", "description": "base64 encoded string to a file", "main": "index.js", "scripts": {