Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: expand the documentation for the path-type option #42

Closed
wants to merge 1 commit into from
Closed

README: expand the documentation for the path-type option #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,21 +95,21 @@ Furthermore, the environment variable can be overridden. This is useful when mul

#### path-type

By default, `MSYS2_PATH_TYPE` is set to `strict` by `msys2`. It is possible to override it either using an option or setting the environment variable explicitly:
Defines which parts of the Windows `$env:PATH` environment variable leak into the MSYS2 environment.

Possible values:

* `strict` *(default)* - Do not inherit anything from `$env:PATH`
* `minimal` - Only inherit the default Windows paths from `$env:PATH` (so that `cmd.exe` is available for example)
* `inherit` - Inherit everything. Warning: This can lead to interference with other tools installed on the system.

```yaml
- uses: msys2/setup-msys2@v1
with:
path-type: inherit
- run: msys2 <command>
path-type: minimal
```

```yaml
- uses: msys2/setup-msys2@v1
- run: msys2 <command>
env:
MSYS2_PATH_TYPE: inherit
```
(This option corresponds to the `MSYS2_PATH_TYPE` setting in MSYS2)

#### release

Expand Down