Skip to content

Commit

Permalink
add option
Browse files Browse the repository at this point in the history
  • Loading branch information
tlambert03 committed Jan 8, 2025
1 parent 1338c4d commit 709a681
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,30 @@ jobs:
- `qt` (default `false`): set to `true` to install libraries required for Qt
on Linux, e.g.:

```yml
- uses: pyvista/setup-headless-display-action@v3
with:
qt: true
```

- `pyvista` (default `true`): set to `false` if you don't want to set env
vars to use PyVista in offscreen mode.

- `window_manager` (default `true`): set to `false` if you don't want to
install a window manager (currently herbstluftwm) on Linux.
This is only applicable for Linux.

- `mesa3d-release` (default `24.3.0`): set to a specific release to install
that version of Mesa3D. This is only applicable for Windows. For example,
to install Mesa3D 21.2.5:

```yml
- uses: pyvista/setup-headless-display-action@v3
with:
mesa3d-release: 21.2.5
```

You can also use `latest` to use the latest release version.

### 🖼️ PyVista Example
Expand Down
10 changes: 7 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@ inputs:
pyvista:
description: "Set PyVista env vars for headless mode"
required: false
default: true
default: "true"
qt:
description: "Install libraries required for Qt on Linux"
required: false
default: false
default: "false"
window_manager:
description: "Install herbstluftwm window manager on Linux"
required: false
default: "true"
mesa3d-release:
description: |
Mesa3D release to install (by default, the latest release is installed).
Expand Down Expand Up @@ -90,7 +94,7 @@ runs:
sleep 3
- name: Start window manager on Linux
if: runner.os == 'Linux'
if: runner.os == 'Linux' && inputs.window_manager != 'false'
shell: bash
run: |
herbstluftwm &
Expand Down

0 comments on commit 709a681

Please sign in to comment.