Skip to content

Commit

Permalink
chore: v0.41.0 [skip test]
Browse files Browse the repository at this point in the history
  • Loading branch information
aminya committed Sep 8, 2024
1 parent 7b3520d commit bfbfe9c
Show file tree
Hide file tree
Showing 15 changed files with 56 additions and 47 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -241,12 +241,12 @@ jobs:
pnpm:
- 9.9.0
container:
- { file: "ubuntu-llvm.dockerfile", image: "setup-cpp-ubuntu-llvm", tag: "22.04-0.40.0" }
- { file: "fedora-llvm.dockerfile", image: "setup-cpp-fedora-llvm", tag: "40-0.40.0" }
- { file: "arch-llvm.dockerfile", image: "setup-cpp-arch-llvm", tag: "base-0.40.0" }
- { file: "ubuntu-mingw.dockerfile", image: "setup-cpp-ubuntu-mingw", tag: "22.04-0.40.0" }
# - { file: "fedora-mingw.dockerfile", image: "setup-cpp-fedora-mingw", tag: "40-0.40.0" }
# - { file: "arch-mingw.dockerfile", image: "setup-cpp-arch-mingw", tag: "base-0.40.0" }
- { file: "ubuntu-llvm.dockerfile", image: "setup-cpp-ubuntu-llvm", tag: "22.04-0.41.0" }
- { file: "fedora-llvm.dockerfile", image: "setup-cpp-fedora-llvm", tag: "40-0.41.0" }
- { file: "arch-llvm.dockerfile", image: "setup-cpp-arch-llvm", tag: "base-0.41.0" }
- { file: "ubuntu-mingw.dockerfile", image: "setup-cpp-ubuntu-mingw", tag: "22.04-0.41.0" }
# - { file: "fedora-mingw.dockerfile", image: "setup-cpp-fedora-mingw", tag: "40-0.41.0" }
# - { file: "arch-mingw.dockerfile", image: "setup-cpp-arch-mingw", tag: "base-0.41.0" }
steps:
- uses: actions/checkout@v4
with:
Expand Down
59 changes: 31 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,13 @@ Run `setup-cpp` with the available options.
```shell
# Windows example (open PowerShell as admin)
npx setup-cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true

RefreshEnv.cmd # activate the environment
# restart the shell to activate the environment
```

```shell
# Linux/Macos example
sudo npx setup-cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true

source ~/.cpprc
source ~/.cpprc # activate cpp environment variables
```

NOTE: In the `compiler` entry, you can specify the version after `-` like `llvm-11.0.0`. For the tools, you can pass a specific version instead of `true` that chooses the default version
Expand All @@ -58,36 +56,41 @@ NOTE: setup-cpp requires Nodejs 12 or higher. If Nodejs shipped with your distri

#### With executable

Download the executable for your platform from [here](https://github.com/aminya/setup-cpp/releases/tag/v0.40.0), and run it with the available options. You can also automate downloading using `wget`, `curl`, or other similar tools.

An example that installs llvm, cmake, ninja, ccache, and vcpkg:
Download the executable for your platform from [here](https://github.com/aminya/setup-cpp/releases/tag/v0.41.0), and run it with the available options. You can also automate downloading using `curl`, or other similar tools.

```shell
# windows example (open PowerShell as admin)
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.40.0/setup-cpp-x64-windows.exe"
./setup-cpp-x64-windows --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
# windows x64
curl -o ./setup-cpp.exe -LJ "https://github.com/aminya/setup-cpp/releases/download/v0.41.0/setup-cpp-x64-windows.exe"

RefreshEnv.cmd # activate cpp environment variables
```
# linux x64
curl -o ./setup-cpp -LJ "https://github.com/aminya/setup-cpp/releases/download/v0.41.0/setup-cpp-x64-linux"
chmod +x ./setup-cpp

```shell
# linux example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.40.0/setup-cpp-x64-linux"
chmod +x ./setup-cpp-x64-linux
sudo ./setup-cpp-x64-linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
# macos arm64
curl -o ./setup-cpp -LJ "https://github.com/aminya/setup-cpp/releases/download/v0.41.0/setup-cpp-arm64-macos"
chmod +x ./setup-cpp

source ~/.cpprc # activate cpp environment variables
# macos x64
curl -o ./setup-cpp -LJ "https://github.com/aminya/setup-cpp/releases/download/v0.41.0/setup-cpp-x64-macos"
chmod +x ./setup-cpp
```

An example that installs llvm, cmake, ninja, ccache, and vcpkg:

```shell
# macos example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.40.0/setup-cpp-x64-macos"
chmod +x ./setup-cpp-x64-macos
sudo ./setup-cpp-x64-macos --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
# windows example (open PowerShell as admin)
./setup-cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
# restart the shell to activate the environment
```

```shell
# linux/macos example
sudo ./setup-cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
source ~/.cpprc # activate cpp environment variables
```

NOTE: On Unix systems, if you are already a root user (e.g., in a GitLab runner or Docker), you will not need to use `sudo`.

### Inside GitHub Actions

Here is a complete cross-platform example that tests llvm, gcc, and msvc. It also uses cmake, ninja, vcpkg, and cppcheck.
Expand Down Expand Up @@ -156,19 +159,19 @@ To provide fast development environments, `setup-cpp` provides several prebuilt
You can use these images as a base image for your project.

```dockerfile
FROM aminya/setup-cpp-ubuntu-llvm:22.04-0.40.0 AS builder
FROM aminya/setup-cpp-ubuntu-llvm:22.04-0.41.0 AS builder
```

```dockerfile
FROM aminya/setup-cpp-ubuntu-mingw:22.04-0.40.0 AS builder
FROM aminya/setup-cpp-ubuntu-mingw:22.04-0.41.0 AS builder
```

```dockerfile
FROM aminya/setup-cpp-fedora-llvm:40-0.40.0 AS builder
FROM aminya/setup-cpp-fedora-llvm:40-0.41.0 AS builder
```

```dockerfile
FROM aminya/setup-cpp-arch-llvm:base-0.40.0 AS builder
FROM aminya/setup-cpp-arch-llvm:base-0.41.0 AS builder
```

The names are in the format `aminya/setup-cpp-<platform>-<compiler>:<platform_version>-<setup_cpp_version>`.
Expand All @@ -187,7 +190,7 @@ RUN apt-get update -qq && \
# install nodejs
apt-get install -y --no-install-recommends nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--nala true \
Expand Down Expand Up @@ -296,7 +299,7 @@ stages:
apt-get install -y --no-install-recommends nodejs npm

# install setup-cpp
npm install -g setup-cpp@v0.40.0
npm install -g setup-cpp@v0.41.0

# install the compiler and tools
./setup-cpp-x64-linux --compiler $compiler --cmake true --ninja true --ccache true --vcpkg true
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-arch-llvm.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ RUN pacman -Syuu --noconfirm && \
# install nodejs
pacman -S --noconfirm --needed nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--compiler llvm \
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-arch-mingw.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ RUN pacman -Syuu --noconfirm && \
# install nodejs
pacman -S --noconfirm --needed nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--compiler mingw \
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-fedora-llvm.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FROM fedora:40 AS setup-cpp-fedora
# install nodejs
RUN dnf -y install nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--compiler llvm \
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-fedora-mingw.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FROM fedora:40 AS setup-cpp-fedora-mingw
# install nodejs
RUN dnf -y install nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--compiler mingw \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ RUN apt-get update -qq && \
apt-get update -qq && \
apt-get install -y --no-install-recommends nodejs && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--nala true \
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-ubuntu-llvm.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ RUN apt-get update -qq && \
# install nodejs
apt-get install -y --no-install-recommends nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--nala true \
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/setup-cpp/setup-cpp-ubuntu-mingw.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ RUN apt-get update -qq && \
# install nodejs
apt-get install -y --no-install-recommends nodejs npm && \
# install setup-cpp
npm install -g setup-cpp@v0.40.0 && \
npm install -g setup-cpp@v0.41.0 && \
# install the compiler and tools
setup-cpp \
--nala true \
Expand Down
2 changes: 1 addition & 1 deletion dist/legacy/setup-cpp.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/modern/setup-cpp.mjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package-version.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "setup-cpp",
"version": "0.40.0"
"version": "0.41.0"
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "setup-cpp",
"version": "0.40.0",
"version": "0.41.0",
"description": "Install all the tools required for building and testing C++/C projects.",
"repository": "https://github.com/aminya/setup-cpp",
"license": "Apache-2.0",
Expand Down
8 changes: 7 additions & 1 deletion packages/setup-brew/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,15 @@ The information about an installation result

### `getBrewBinDir` (function)

Get the path to the bin directory of brew

**returns:** string

### `getBrewDir` (function)

Get the path where brew is installed

**returns:** "/opt/homebrew/bin/" | "/usr/local/bin/" | "/home/linuxbrew/.linuxbrew/bin/"
**returns:** "/opt/homebrew" | "/usr/local" | "/home/linuxbrew/.linuxbrew"

### `BrewPackOptions` (type)

Expand Down
2 changes: 1 addition & 1 deletion packages/setup-brew/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "setup-brew",
"version": "1.0.0",
"version": "1.0.1",
"description": "Setup brew and brew packages",
"repository": "https://github.com/aminya/setup-cpp",
"homepage": "https://github.com/aminya/setup-cpp/tree/master/packages/setup-brew",
Expand Down

0 comments on commit bfbfe9c

Please sign in to comment.