Skip to content

Commit 18eff1b

Browse files
authored
Merge pull request #8 from Trepp/main
chore: version bump, update deps and readme
2 parents d595af1 + 5ce2e9d commit 18eff1b

File tree

4 files changed

+537
-475
lines changed

4 files changed

+537
-475
lines changed

README.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
1-
![build-test](https://github.com/Trepp/actions-render-wsq/workflows/build-test/badge.svg?branch=main)
2-
31
# GitHub Action to render web sequence diagrams
42

3+
![build-test](https://github.com/Trepp/actions-render-wsq/workflows/build-test/badge.svg?branch=main)
4+
55
This action will automatically render images for [web sequence diagrams](https://www.websequencediagrams.com/examples.html) in a given project folder :rocket:
66

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
831

932
## Quickstart Development on the Action
1033

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+
1136
Install the dependencies
1237

1338
```bash
@@ -35,11 +60,7 @@ npm test
3560

3661
### Change action.yml
3762

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)
4364

4465
### Change the Code
4566

@@ -63,7 +84,7 @@ run()
6384

6485
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
6586

66-
## Publish new version
87+
### Publish new version
6788

6889
Actions are run from GitHub repos so we will checkin the packed dist folder.
6990

@@ -81,7 +102,7 @@ Your action is now published! :rocket:
81102

82103
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
83104

84-
## Validate
105+
### Validate
85106

86107
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
87108

@@ -93,6 +114,6 @@ with:
93114
94115
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
95116
96-
## Usage
117+
### Usage
97118
98119
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

Comments
 (0)