Skip to content

Commit 79ea24a

Browse files
feat: build for release
1 parent af54e06 commit 79ea24a

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# `ts-graphviz/setup-graphviz` action
22
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3-
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
55

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

88
## Example usage
99

10+
With `ts-graphviz/setup-graphviz`, you can set up a GitHub Action environment
11+
that allows you to use `Graphviz` on all operating systems.
12+
1013
```yml
1114
name: Graphviz CI
1215
on: [push]
@@ -25,6 +28,21 @@ jobs:
2528
# In the steps below this you can use Graphviz dot command.
2629
```
2730

31+
If you want a fixed version of Graphviz,
32+
you can specify a specific version for each operating system (not macOS).
33+
34+
```yaml
35+
- name: Setup Graphviz
36+
uses: ts-graphviz/setup-graphviz@v1
37+
with:
38+
# graphviz version on Ubuntu.
39+
ubuntu-graphviz-version: '2.42.2-3build2'
40+
# libgraphviz-dev version on Ubuntu.
41+
ubuntu-libgraphvizdev-version: '2.42.2-3build2'
42+
# graphviz version on Windows.
43+
windows-graphviz-version: '2.49.3'
44+
```
45+
2846
## See Also
2947
3048
Graphviz-dot Test and Integration
@@ -54,6 +72,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
5472
<td align="center"><a href="https://smcleod.net"><img src="https://avatars.githubusercontent.com/u/862951?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sam</b></sub></a><br /><a href="#maintenance-sammcj" title="Maintenance">🚧</a></td>
5573
<td align="center"><a href="https://github.com/mohawk2"><img src="https://avatars.githubusercontent.com/u/7308181?v=4?s=100" width="100px;" alt=""/><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>
5674
<td align="center"><a href="https://github.com/leadelngalame1611"><img src="https://avatars.githubusercontent.com/u/39901966?v=4?s=100" width="100px;" alt=""/><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>
75+
<td align="center"><a href="https://github.com/stunney"><img src="https://avatars.githubusercontent.com/u/609012?v=4?s=100" width="100px;" alt=""/><br /><sub><b>S. Tunney</b></sub></a><br /><a href="#ideas-stunney" title="Ideas, Planning, & Feedback">🤔</a></td>
5776
</tr>
5877
</table>
5978

0 commit comments

Comments
 (0)