You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This action will automatically render images for [web sequence diagrams](https://www.websequencediagrams.com/examples.html) in a given project folder :rocket:
6
6
7
-
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
7
+
After the action runs new png images will be created for any *.wsq files in the specified folder. These can then be committed.
8
+
9
+
## Inputs
10
+
11
+
### `folder`
12
+
13
+
**Required** This can be a relative folder starting from the project root. ie: `./docs/diagrams` The action will scan for all files in this folder, but does not look at sub-folders.
14
+
15
+
### `style`
16
+
17
+
**Optional** Specify a UI style for how the diagrams will be rendered. Available options include:
18
+
19
+
* default
20
+
* earth
21
+
* modern-blue
22
+
* mscgen
23
+
* omegapple
24
+
* qsd
25
+
* rose
26
+
* roundgreen
27
+
* napkin
28
+
* magazine
29
+
* vs2010
30
+
* patent
8
31
9
32
## Quickstart Development on the Action
10
33
34
+
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
35
+
11
36
Install the dependencies
12
37
13
38
```bash
@@ -35,11 +60,7 @@ npm test
35
60
36
61
### Change action.yml
37
62
38
-
The action.yml contains defines the inputs and output for your action.
39
-
40
-
Update the action.yml with your name, description, inputs and outputs for your action.
41
-
42
-
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
63
+
The action.yml contains defines the inputs and output for your action. See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
43
64
44
65
### Change the Code
45
66
@@ -63,7 +84,7 @@ run()
63
84
64
85
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
65
86
66
-
## Publish new version
87
+
###Publish new version
67
88
68
89
Actions are run from GitHub repos so we will checkin the packed dist folder.
69
90
@@ -81,7 +102,7 @@ Your action is now published! :rocket:
81
102
82
103
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
83
104
84
-
## Validate
105
+
###Validate
85
106
86
107
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
87
108
@@ -93,6 +114,6 @@ with:
93
114
94
115
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
95
116
96
-
## Usage
117
+
### Usage
97
118
98
119
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
0 commit comments