aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: f6df9152e4df2022453e4ff758d794919cb4608d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
Set up Clang
============

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

This GitHub action sets up Clang & LLVM in your workflow run.

1. Installs either 32-bit or 64-bit Clang & LLVM on either Ubuntu or Windows.
2. Specify a version to install using the `version` parameter.

Use it in your workflow like this:

    - name: Set up Clang
      uses: egor-tensin/setup-clang@v2
      with:
        version: latest
        platform: x64

* `latest` is the default value for the `version` parameter and can be omitted.
* `x64` is the default value for the `platform` parameter and can be omitted.
Use `x86` if you want to build 32-bit binaries.
* `cc` and `c++` executables are set up, pointing to the `clang` and `clang++`
executables.
Disable this by setting the `cc` parameter to `0`.

API
---

| Input     | Value   | Default | Description
| --------- | ------- | ------- | -----------
| version   | latest  | ✓       | Install the latest version available in the repository.
|           | *any*   |         | Install a specific version if it's available (see below).
| platform  | x64     | ✓       | Install the x86_64 toolchain.
|           | *any*   |         | Install the i686 toolchain.
| cc        | 1       | ✓       | Set up `cc`/`clang`/`c++`/`clang++` executables.
|           | *any*   |         | Don't set up the executables.

| Output  | Example   | Description
| ------- | --------- | -----------
| clang   | clang-4.0 | `clang` binary name
| clangxx | clang++-7 | `clang++` binary name
| lld     | ld.lld-10 | `ld.lld` binary name

Supported versions
------------------

Unless the `version` parameter value is "latest", the official LLVM repository
is used to make more versions available.
You can pass the version number as the `version` parameter value (`13`, `17`,
`20`, etc.), and this action will install the corresponding packages.

The `version` parameter value is not checked for being an available version for
the current distribution.
The supported versions for a particular distribution are those found in that
distro's repositories & those in the LLVM repository.
For example, you can find the list of available versions as of April 2026
below.

| `version` | Jammy | Noble
| --------- | ----- | -----
| 11        | ✓     |
| 12        | ✓     |
| 13        | ✓     |
| 14        | ✓     | ✓
| 15        | ✓     | ✓
| 16        | ✓     | ✓
| 17        | ✓     | ✓
| 18        | ✓     | ✓
| 19        | ✓     | ✓
| 20        | ✓     | ✓
| 21        | ✓     | ✓
| 22        | ✓     | ✓

This table should be updated periodically; it's a work-in-progress.
(Note to self: the supported versions are those found in [Ubuntu repos] and
the official [LLVM repos]).

[Ubuntu repos]: https://packages.ubuntu.com/
[LLVM repos]: https://apt.llvm.org/

On Windows, the `version` parameter is ignored.

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt