Skip to content

Commit

Permalink
- Update README
Browse files Browse the repository at this point in the history
- Cosmetic changes
  • Loading branch information
aidmax committed Nov 20, 2020
1 parent 92a0513 commit 605abca
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
on: [push]

jobs:
hello_world_job:
structurizr-cli:
runs-on: ubuntu-latest
name: Run structurizr-cli
steps:

- name: Checkout
uses: actions/checkout@v2

- name: Hello world action step
- name: Run structurizr-cli action
uses: ./
id: test
with:
Expand Down
42 changes: 41 additions & 1 deletion README.md
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).

0 comments on commit 605abca

Please sign in to comment.