mirror of
https://github.com/egor-tensin/cleanup-path.git
synced 2025-05-01 00:59:32 +03:00
add README
This commit is contained in:
parent
f38a95ebf9
commit
4e107ad23e
1 changed files with 38 additions and 0 deletions
38
README.md
Normal file
38
README.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
Clean up PATH
|
||||
=============
|
||||
|
||||
[](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
|
Loading…
Add table
Reference in a new issue