Home

Awesome

ts-graphviz/setup-graphviz action

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

All Contributors

<!-- ALL-CONTRIBUTORS-BADGE:END -->

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

Contributing

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

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="http://blog.kamiazya.tech/"><img src="https://avatars0.githubusercontent.com/u/35218186?v=4?s=100" width="100px;" alt="Yuki Yamazaki"/><br /><sub><b>Yuki Yamazaki</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=kamiazya" title="Code">πŸ’»</a> <a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=kamiazya" title="Tests">⚠️</a> <a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=kamiazya" title="Documentation">πŸ“–</a> <a href="#example-kamiazya" title="Examples">πŸ’‘</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mhtb32"><img src="https://avatars3.githubusercontent.com/u/24754239?v=4?s=100" width="100px;" alt="Mohammad Hussein Tavakoli Bina "/><br /><sub><b>Mohammad Hussein Tavakoli Bina </b></sub></a><br /><a href="#ideas-mhtb32" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://smcleod.net"><img src="https://avatars.githubusercontent.com/u/862951?v=4?s=100" width="100px;" alt="Sam"/><br /><sub><b>Sam</b></sub></a><br /><a href="#maintenance-sammcj" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mohawk2"><img src="https://avatars.githubusercontent.com/u/7308181?v=4?s=100" width="100px;" alt="mohawk2"/><br /><sub><b>mohawk2</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Amohawk2" title="Bug reports">πŸ›</a> <a href="#ideas-mohawk2" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/leadelngalame1611"><img src="https://avatars.githubusercontent.com/u/39901966?v=4?s=100" width="100px;" alt="leadelngalame1611"/><br /><sub><b>leadelngalame1611</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Aleadelngalame1611" title="Bug reports">πŸ›</a> <a href="#ideas-leadelngalame1611" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/stunney"><img src="https://avatars.githubusercontent.com/u/609012?v=4?s=100" width="100px;" alt="S. Tunney"/><br /><sub><b>S. Tunney</b></sub></a><br /><a href="#ideas-stunney" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://paul.kishimoto.name"><img src="https://avatars.githubusercontent.com/u/1634164?v=4?s=100" width="100px;" alt="Paul Natsuo Kishimoto"/><br /><sub><b>Paul Natsuo Kishimoto</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Akhaeru" title="Bug reports">πŸ›</a> <a href="#research-khaeru" title="Research">πŸ”¬</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jbms"><img src="https://avatars.githubusercontent.com/u/4211946?v=4?s=100" width="100px;" alt="Jeremy Maitin-Shepard"/><br /><sub><b>Jeremy Maitin-Shepard</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Ajbms" title="Bug reports">πŸ›</a> <a href="#ideas-jbms" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mvrueden"><img src="https://avatars.githubusercontent.com/u/4202259?v=4?s=100" width="100px;" alt="mvrueden"/><br /><sub><b>mvrueden</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Amvrueden" title="Bug reports">πŸ›</a> <a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=mvrueden" title="Code">πŸ’»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://dhimmel.com"><img src="https://avatars.githubusercontent.com/u/1117703?v=4?s=100" width="100px;" alt="Daniel Himmelstein"/><br /><sub><b>Daniel Himmelstein</b></sub></a><br /><a href="#question-dhimmel" title="Answering Questions">πŸ’¬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/deining"><img src="https://avatars.githubusercontent.com/u/18169566?v=4?s=100" width="100px;" alt="Andreas Deininger"/><br /><sub><b>Andreas Deininger</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=deining" title="Documentation">πŸ“–</a> <a href="#maintenance-deining" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="http://devmonstr.com"><img src="https://avatars.githubusercontent.com/u/17883887?v=4?s=100" width="100px;" alt="Joshua Strohminger"/><br /><sub><b>Joshua Strohminger</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=joshstrohminger" title="Code">πŸ’»</a> <a href="#maintenance-joshstrohminger" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/2bndy5"><img src="https://avatars.githubusercontent.com/u/14963867?v=4?s=100" width="100px;" alt="Brendan"/><br /><sub><b>Brendan</b></sub></a><br /><a href="#maintenance-2bndy5" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/glatterf42"><img src="https://avatars.githubusercontent.com/u/83776373?v=4?s=100" width="100px;" alt="Fridolin Glatter"/><br /><sub><b>Fridolin Glatter</b></sub></a><br /><a href="#maintenance-glatterf42" title="Maintenance">🚧</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Maetveis"><img src="https://avatars.githubusercontent.com/u/8176760?v=4?s=100" width="100px;" alt="MΓ©szΓ‘ros Gergely"/><br /><sub><b>MΓ©szΓ‘ros Gergely</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3AMaetveis" title="Bug reports">πŸ›</a> <a href="https://github.com/ts-graphviz/setup-graphviz/commits?author=Maetveis" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/XF-FW"><img src="https://avatars.githubusercontent.com/u/98830734?v=4?s=100" width="100px;" alt="Xavier Francisco"/><br /><sub><b>Xavier Francisco</b></sub></a><br /><a href="#ideas-XF-FW" title="Ideas, Planning, & Feedback">πŸ€”</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/stinodego"><img src="https://avatars.githubusercontent.com/u/3502351?v=4?s=100" width="100px;" alt="Stijn de Gooijer"/><br /><sub><b>Stijn de Gooijer</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Astinodego" title="Bug reports">πŸ›</a></td> <td align="center" valign="top" width="14.28%"><a href="http://jakebeal.com"><img src="https://avatars.githubusercontent.com/u/10675899?v=4?s=100" width="100px;" alt="Jacob Beal"/><br /><sub><b>Jacob Beal</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Ajakebeal" title="Bug reports">πŸ›</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrbuslov"><img src="https://avatars.githubusercontent.com/u/68155915?v=4?s=100" width="100px;" alt="Dmitry Buslov"/><br /><sub><b>Dmitry Buslov</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Amrbuslov" title="Bug reports">πŸ›</a></td> <td align="center" valign="top" width="14.28%"><a href="https://vkottler.github.io/"><img src="https://avatars.githubusercontent.com/u/15205052?v=4?s=100" width="100px;" alt="Vaughn Kottler"/><br /><sub><b>Vaughn Kottler</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Avkottler" title="Bug reports">πŸ›</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/gpaulfleetwood"><img src="https://avatars.githubusercontent.com/u/56100336?v=4?s=100" width="100px;" alt="gpaulfleetwood"/><br /><sub><b>gpaulfleetwood</b></sub></a><br /><a href="https://github.com/ts-graphviz/setup-graphviz/issues?q=author%3Agpaulfleetwood" title="Bug reports">πŸ›</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

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

License

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