Skip to content

Commit

Permalink
updating README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lokkju committed Jul 31, 2019
1 parent ed858fe commit 2fb7517
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,35 @@
# github-action-plantuml
Github Action to allow generating outputs from plantuml files
# Github Action for PlantUML
Github Action to allow generating outputs from [PlantUML](http://plantuml.com) files

http://plantuml.com/command-line
## Documentation

Please see the [PlantUML CLI documentation](http://plantuml.com/command-line) for details

## How to use

To use this action we need a PlantUML *.puml file. By default, a PNG image will be generated in the same directory for each *.puml file you provide

In your project create a new workflow file `.github/main.workflow`:
```
workflow "Generate PlantUML Images" {
resolves = ["Generate UML"]
on = "push"
}
action "Generate UML" {
uses = "lokkju/github-action-plantuml@master"
args = ["uml/example.puml"]
}
```

This will generate a PNG image for the example.puml file.

## Notes

This action only runs the PlantUML generation currently. You will need to chain it with other actions in order to commit the newly created output files.

## TODO

- Only run if the input puml files have been changed
- Automatically commit generated output files

0 comments on commit 2fb7517

Please sign in to comment.