cleanup-path/README.md
2021-04-18 08:49:14 +03:00

1.5 KiB

Clean up PATH

Test

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@v2
  • You can pass additional directory paths to add to PATH using the dirs parameter.
  • System directories under C:\Windows are added to PATH by default. Disable this by setting the default parameter to 0.

API

Input Value Default Description
dirs Empty No additional paths.
Other Additional paths, separated by a semicolon (;).
default 1 Add the default directories under C:\Windows.
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, 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.