aboutsummaryrefslogblamecommitdiffstatshomepage
path: root/README.md
blob: 7e42659f62354812a085aa3eb8487154e9634373 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12


             
                                                                                                                                                                   







                                                                               
                                       
























                                                                               
Clean up PATH
=============

[![Test](https://github.com/egor-tensin/cleanup-path/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/cleanup-path/actions/workflows/test.yml)

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

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