v2.3.0 1dffee8

Author: eine

README.md

@@ -10,11 +10,16 @@
 
 # Setup MSYS2
 
-**setup-msys2** is a JavaScript GitHub Action (GHA) to setup an [MSYS2](https://www.msys2.org/) environment (i.e. MSYS, MINGW32, MINGW64 and/or UCRT64 shells) using the GHA [toolkit](https://github.com/actions/toolkit) for automatic caching.
+**setup-msys2** is a JavaScript GitHub Action (GHA) to setup an [MSYS2](https://www.msys2.org/) environment (i.e. MSYS,
+MINGW32, MINGW64, UCRT64 and/or CLANG64 shells) using the GHA [toolkit](https://github.com/actions/toolkit) for
+automatic caching.
 
 ## Context
 
-[MSYS2](https://www.msys2.org/) is available by default in [windows-latest](https://github.com/actions/virtual-environments/blob/master/images/win/Windows2019-Readme.md#msys2) [virtual environment](https://github.com/actions/virtual-environments) for GitHub Actions, located at `C:\msys64`. Moreover, there is work in progress for making `bash` default to MSYS2 (see [actions/virtual-environments#1525](https://github.com/actions/virtual-environments/issues/1525)). However, the default installation has some caveats at the moment (see [actions/virtual-environments#1572](https://github.com/actions/virtual-environments/issues/1572)):
+[MSYS2](https://www.msys2.org/) is available by default in [windows-latest](https://github.com/actions/virtual-environments/blob/master/images/win/Windows2019-Readme.md#msys2)
+[virtual environment](https://github.com/actions/virtual-environments) for GitHub Actions, located at `C:\msys64`.
+Moreover, there is work in progress for making `bash` default to MSYS2 (see [actions/virtual-environments#1525](https://github.com/actions/virtual-environments/issues/1525)).
+However, the default installation has some caveats at the moment (see [actions/virtual-environments#1572](https://github.com/actions/virtual-environments/issues/1572)):
 
 - It is updated every ~10 days.
 - It includes a non-negligible set of pre-installed packages. As a result, update time can be up to 10 min.
@@ -23,10 +28,14 @@
 
 **setup-msys2** works around those constraints:
 
-- Using option `release: false`, the default installation is used, but automatic caching is supported and a custom entrypoint is provided.
-- By default (`release: true`), **setup-msys2** downloads and extracts the latest tarball available at [repo.msys2.org/distrib/x86_64](http://repo.msys2.org/distrib/x86_64/), a clean and up-to-date environment is set up in a temporary location, and a custom entrypoint (`msys2`) is provided. Hence, the overhead of updating pre-installed but unnecessary packages is avoided.
+- Using option `release: false`, the default installation is used, but automatic caching is supported and a custom
+entrypoint is provided.
+- By default (`release: true`), **setup-msys2** downloads and extracts the latest tarball available at [repo.msys2.org/distrib/x86_64](http://repo.msys2.org/distrib/x86_64/),
+a clean and up-to-date environment is set up in a temporary location, and a custom entrypoint (`msys2`) is provided.
+Hence, the overhead of updating pre-installed but unnecessary packages is avoided.
 
-Therefore, usage of this Action is recommended to all MSYS2 users of GitHub Actions, since caching and the custom entrypoint are provided regardless of option `release`.
+Therefore, usage of this Action is recommended to all MSYS2 users of GitHub Actions, since caching and the custom
+entrypoint are provided regardless of option `release`.
 
 ## Usage
 
@@ -42,7 +51,8 @@ Then, for scripts:
       uname -a
 ```
 
-It is also possible to execute specific commands from cmd/powershell scripts/snippets. In order to do so, `-c` is required:
+It is also possible to execute specific commands from cmd/powershell scripts/snippets.
+In order to do so, `-c` is required:
 
 ```yaml
   - shell: powershell
@@ -75,11 +85,16 @@ In order to reduce verbosity, it is possible to set `msys2` as the default shell
   - run: git describe --dirty
 ```
 
-Note that setting `autocrlf` is required in specific use cases only. See [actions/checkout#250](https://github.com/actions/checkout/issues/250).
+Note that setting `autocrlf` is required in specific use cases only.
+See [actions/checkout#250](https://github.com/actions/checkout/issues/250).
 
 ### Build matrix
 
-It is common to test some package/tool on MINGW32 (32 bit) and MINGW64 (64 bit), which typically requires installing different sets of packages through option `install`. GitHub Actions' `strategy` and `matrix` fields allow to do so, as explained in [docs.github.com: Configuring a build matrix](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#configuring-a-build-matrix) and [docs.github.com: `jobs.<job_id>.strategy.matrix`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix). See, for example:
+It is common to test some package/tool on MINGW32 (32 bit) and MINGW64 (64 bit), which typically requires installing
+different sets of packages through option `install`.
+GitHub Actions' `strategy` and `matrix` fields allow to do so, as explained in [docs.github.com: Configuring a build matrix](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#configuring-a-build-matrix)
+and [docs.github.com: `jobs.<job_id>.strategy.matrix`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix).
+See, for example:
 
 - [msys2/MINGW-packages: .github/workflows/main.yml](https://github.com/msys2/MINGW-packages/blob/master/.github/workflows/main.yml).
 - [ghdl/ghdl: .github/workflows/push.yml](https://github.com/ghdl/ghdl/blob/99b542c849311c92e87e2c70d283de133c9d4093/.github/workflows/push.yml#L56-L102).
@@ -90,15 +105,19 @@ Find further details at [#40](https://github.com/msys2/setup-msys2/issues/40) an
 
 #### msystem
 
-By default, `MSYSTEM` is set to `MINGW64`. However, an optional parameter named `msystem` is supported, which expects `MSYS`, `MINGW64`, `MINGW32` or `UCRT64`. For example:
+By default, `MSYSTEM` is set to `MINGW64`. However, an optional parameter named `msystem` is supported, which expects
+`MSYS`, `MINGW64`, `MINGW32`, `UCRT64` or `CLANG64`.
+For example:
 
 ```yaml
   - uses: msys2/setup-msys2@v2
     with:
       msystem: MSYS
 ```
 
-Furthermore, the environment variable can be overridden. This is useful when multiple commands need to be executed in different contexts. For example, in order to build a PKGBUILD file and then test the installed artifact:
+Furthermore, the environment variable can be overridden.
+This is useful when multiple commands need to be executed in different contexts.
+For example, in order to build a PKGBUILD file and then test the installed artifact:
 
 ```yaml
   - uses: msys2/setup-msys2@v2
@@ -115,10 +134,12 @@ Furthermore, the environment variable can be overridden. This is useful when mul
 
 #### path-type
 
-Defines which parts of the Windows `$env:PATH` environment variable leak into the MSYS2 environment. Allowed values:
+Defines which parts of the Windows `$env:PATH` environment variable leak into the MSYS2 environment.
+Allowed values:
 
 - `strict`: do not inherit anything from `$env:PATH`.
-- `minimal` *(default)*: only inherit the default Windows paths from `$env:PATH` (so that `cmd.exe` and `powershell.exe` are available for example).
+- `minimal` *(default)*: only inherit the default Windows paths from `$env:PATH` (so that `cmd.exe` and `powershell.exe`
+  are available for example).
 - `inherit`: inherit everything; warning: this can lead to interference with other tools installed on the system.
 
 ```yaml
@@ -127,11 +148,14 @@ Defines which parts of the Windows `$env:PATH` environment variable leak into th
       path-type: minimal
 ```
 
-This option corresponds to the `MSYS2_PATH_TYPE` setting in MSYS2; hence it can be set per step through `env`. See [msys2/MSYS2-packages: filesystem/profile](https://github.com/msys2/MSYS2-packages/blob/915946a637e1f2b7e26e32782f3af322009293db/filesystem/profile#L28-L45) for further details about the configuration of each option.
+This option corresponds to the `MSYS2_PATH_TYPE` setting in MSYS2; hence it can be set per step through `env`.
+See [msys2/MSYS2-packages: filesystem/profile](https://github.com/msys2/MSYS2-packages/blob/915946a637e1f2b7e26e32782f3af322009293db/filesystem/profile#L28-L45)
+for further details about the configuration of each option.
 
 #### release
 
-By default (`true`), retrieve and extract base installation from upstream GitHub Releases. If set to `false`, the installation available in the virtual environment is used:
+By default (`true`), retrieve and extract base installation from upstream GitHub Releases.
+If set to `false`, the installation available in the virtual environment is used:
 
 ```yaml
   - uses: msys2/setup-msys2@v2
@@ -141,7 +165,8 @@ By default (`true`), retrieve and extract base installation from upstream GitHub
 
 #### update
 
-By default, the installation is not updated; hence package versions are those of the installation tarball. By setting option `update` to `true`, the action will try to update the runtime and packages cleanly:
+By default, the installation is not updated; hence package versions are those of the installation tarball.
+By setting option `update` to `true`, the action will try to update the runtime and packages cleanly:
 
 ```yaml
   - uses: msys2/setup-msys2@v2
@@ -151,7 +176,8 @@ By default, the installation is not updated; hence package versions are those of
 
 #### install
 
-Installing additional packages after updating the system is supported through option `install`. The package or list of packages are installed through `pacman --noconfirm -S --needed`.
+Installing additional packages after updating the system is supported through option `install`.
+The package or list of packages are installed through `pacman --noconfirm -S --needed`.
 
 ```yaml
   - uses: msys2/setup-msys2@v2

action.yml

@@ -5,7 +5,7 @@ branding:
   icon: terminal
 inputs:
   msystem:
-    description: 'Variant of the environment to set by default: MSYS, MINGW32, MINGW64 or UCRT64'
+    description: 'Variant of the environment to set by default: MSYS, MINGW32, MINGW64, UCRT64 or CLANG64'
     required: false
     default: 'MINGW64'
   path-type: