ts-graphviz/setup-graphviz action

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

See Also

Graphviz-dot Test and Integration

• ts-graphviz
  • Graphviz library for TypeScript.
• @ts-graphviz/react
  • Graphviz-dot Renderer for React.
• jest-graphviz
  • Jest matchers that supports graphviz 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 💻 ⚠️ 📖 💡	Mohammad Hussein Tavakoli Bina 🤔	Sam 🚧	mohawk2 🐛 🤔	leadelngalame1611 🐛 🤔	S. Tunney 🤔	Paul Natsuo Kishimoto 🐛 🔬
Jeremy Maitin-Shepard 🐛 🤔	mvrueden 🐛 💻	Daniel Himmelstein 💬	Andreas Deininger 📖 🚧	Joshua Strohminger 💻 🚧	Brendan 🚧	Fridolin Glatter 🚧
Mészáros Gergely 🐛 ⚠️	Xavier Francisco 🤔	Stijn de Gooijer 🐛	Jacob Beal 🐛	Dmitry Buslov 🐛	Vaughn Kottler 🐛	gpaulfleetwood 🐛

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

License

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