From 4e107ad23e75e456e6c431d745a81e427b8eec18 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 24 Dec 2020 04:06:19 +0300 Subject: add README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d6f3e2 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +Clean up PATH +============= + +[![Test](https://github.com/egor-tensin/cleanup-path/workflows/Test/badge.svg)](https://github.com/egor-tensin/cleanup-path/actions?query=workflow%3ATest) + +The PATH variable on Windows runners is a cesspool. +For example, it includes seemingly dozens of MinGW distributions. +This action takes a page out of MSYS2's book here, and cleans PATH so that only +the default paths are included. +Use it in your workflow like this: + + - name: Clean up PATH + uses: egor-tensin/cleanup-path@v1 + +API +--- + +| Input | Value | Default | Description +| ------- | ------- | ------- | ----------- +| dirs | *Empty* | Yes | No additional paths. +| | *Other* | No | Additional paths, separated by a semicolon (;). +| default | 1 | Yes | Add the default directories under C:\Windows. +| | *Other* | No | 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`, +it might not clear your PATH completely. +Actions like `setup-python`, etc. have a way to propagate their values to PATH +regardless. +Also, your `shell` selection matters. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt -- cgit v1.2.3