Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ts-graphviz/setup-graphviz

▶️ GitHub Action to set up Graphviz cross-platform(Linux, macOS, Windows).
https://github.com/ts-graphviz/setup-graphviz

github-actions graphviz graphviz-cross-platform setup-graphviz

Last synced: 6 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# `ts-graphviz/setup-graphviz` action

[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat-square)](#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.

```yml
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).

```yaml
- 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](https://github.com/ts-graphviz/ts-graphviz)
- Graphviz library for TypeScript.
- [@ts-graphviz/react](https://github.com/ts-graphviz/react)
- Graphviz-dot Renderer for React.
- [jest-graphviz](https://github.com/ts-graphviz/jest-graphviz)
- Jest matchers that supports graphviz integration.

## Contributing

For more info on how to contribute to setup-graphviz, see the [CONTRIBUTING](./CONTRIBUTING.md).

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

This software is released under the MIT License, see [LICENSE](./LICENSE).