Skip to content

Setup Graphviz

Actions

About

Setup a graphviz environment and add it to the PATH
v2.0.3
Latest
StarΒ (46)

ts-graphviz/setup-graphviz action

All Contributors

GitHub Action to set up Graphviz cross-platform(Linux, macOS, Windows).

Example usage

With ts-graphviz/setup-graphviz, you can set up a GitHub Action environment that allows you to use Graphviz on all operating systems.

name: Graphviz CI
on: [push]
jobs:
  test:
    name: Test on node ${{ matrix.node-version }} and ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
    - uses: actions/checkout@v4
    - name: Setup Graphviz
      uses: ts-graphviz/setup-graphviz@v2
    ...
    # In the steps below this you can use Graphviz dot command.

If you want a fixed version of Graphviz, you can specify a specific version for each operating system (not macOS).

- name: Setup Graphviz
  uses: ts-graphviz/setup-graphviz@v2
  with:
    # graphviz version on Ubuntu.
    ubuntu-graphviz-version: '2.42.2-3build2'
    # libgraphviz-dev version on Ubuntu.
    ubuntu-libgraphvizdev-version: '2.42.2-3build2'
    # Skip to run apt update command on Ubuntu.
    ubuntu-skip-apt-update: 'true' # default false
    #  graphviz version on Windows.
    windows-graphviz-version: '2.49.3'
    # Skip to run brew update command on macOS.
    macos-skip-brew-update: 'true' # default false

Windows: checking the install

On Windows, the action installs Graphviz with Chocolatey. When the Chocolatey community feed is unavailable, choco install can exit successfully without installing anything, so the action checks that choco succeeded and that dot -V runs afterwards. If not, the action runs choco install graphviz --force again after 30 and then 60 seconds, and fails the step if Graphviz is still missing after three attempts (#649).

See Also

Graphviz-dot Test and Integration

Contributing

For more info on how to contribute to setup-graphviz, see the CONTRIBUTING.

Contributors

Thanks goes to these wonderful people (emoji key):

Yuki Yamazaki
Yuki Yamazaki

πŸ’» ⚠️ πŸ“– πŸ’‘
Mohammad Hussein Tavakoli Bina
Mohammad Hussein Tavakoli Bina

πŸ€”
Sam
Sam

🚧
mohawk2
mohawk2

πŸ› πŸ€”
leadelngalame1611
leadelngalame1611

πŸ› πŸ€”
S. Tunney
S. Tunney

πŸ€”
Paul Natsuo Kishimoto
Paul Natsuo Kishimoto

πŸ› πŸ”¬
Jeremy Maitin-Shepard
Jeremy Maitin-Shepard

πŸ› πŸ€”
mvrueden
mvrueden

πŸ› πŸ’»
Daniel Himmelstein
Daniel Himmelstein

πŸ’¬
Andreas Deininger
Andreas Deininger

πŸ“– 🚧
Joshua Strohminger
Joshua Strohminger

πŸ’» 🚧
Brendan
Brendan

🚧
Fridolin Glatter
Fridolin Glatter

🚧
MΓ©szΓ‘ros Gergely
MΓ©szΓ‘ros Gergely

πŸ› ⚠️
Xavier Francisco
Xavier Francisco

πŸ€”
Stijn de Gooijer
Stijn de Gooijer

πŸ›
Jacob Beal
Jacob Beal

πŸ›
Dmitry Buslov
Dmitry Buslov

πŸ›
Vaughn Kottler
Vaughn Kottler

πŸ›
gpaulfleetwood
gpaulfleetwood

πŸ›

This project follows the all-contributors specification. Contributions of any kind welcome!

License

This software is released under the MIT License, see LICENSE.

Setup Graphviz is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Setup a graphviz environment and add it to the PATH
v2.0.3
Latest

Setup Graphviz is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.