aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-04-18 08:54:56 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-04-18 08:54:56 +0300
commit3afb58257679a3d08933c9c94e99695d4ff78a50 (patch)
tree4ec814b4c080dac9235466220196928b8bd47114
parentREADME: update (diff)
downloadcleanup-path-3afb58257679a3d08933c9c94e99695d4ff78a50.tar.gz
cleanup-path-3afb58257679a3d08933c9c94e99695d4ff78a50.zip
README: update
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 446269c..446e613 100644
--- a/README.md
+++ b/README.md
@@ -28,11 +28,23 @@ API
| | *Other* | | Don't add the default directories.
The action sets the PATH environment variable.
-Note that even if you call it with `default: 0` and don't specify any `dirs`,
+
+Notes
+-----
+
+* Even if you call the action with `default: 0` and don't specify any `dirs`,
it might not clear your PATH completely.
-Actions like `setup-python`, etc. have a way to propagate their values to PATH
-regardless.
+Actions like `setup-python`, etc. seem to have a way to propagate their values
+to PATH regardless.
Also, your `shell` selection matters.
+* v1 of this action is a simple composite action with the same API.
+At some point, it turned out that restoring PATH value might be desirable in
+the action's `post` stage.
+In particular, the GitHub-provided `cache` action wasn't able to find the `tar`
+executable on windows-2016 images (windows-2019 images have it built-in under
+C:\Windows).
+Composite actions don't support having the `post` stage, so it became a
+JavaScript action.
License
-------