-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Cosmetic changes
- Loading branch information
Showing
2 changed files
with
43 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,41 @@ | ||
# structurizr-cli-action | ||
# Structurizr-cli Action | ||
|
||
This action allows you to run `structurizr-cli`. | ||
|
||
## Usage | ||
|
||
To use the action simply create an `structurizr-cli.yml` (or choose custom `*.yml` name) in the `.github/workflows/` directory. | ||
|
||
For example: | ||
|
||
```yaml | ||
name: sctructurizr-cli # feel free to pick your own name | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
structurizr-cli: | ||
runs-on: ubuntu-latest | ||
name: Run structurizr-cli | ||
steps: | ||
|
||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Run structurizr-cli action | ||
uses: actions/structurizr-cli-action | ||
id: test | ||
with: | ||
id: # required | ||
key: # required | ||
secret: # required | ||
workspace: # required | ||
``` | ||
## License | ||
The Dockerfile and associated scripts and documentation in this project are released under the [MIT](license). | ||
## Credits | ||
The initial GitHub action has been created by [Maksim Milykh](https://github.com/aidmax). |