Action to Mermaid
βΆοΈ toπ§ββοΈ
About
Now that GitHub renders Mermaid diagrams, here is a GitHub action that generates a Mermaid diagram out of an action's metadata file.
Overview
flowchart LR
input1(nwo):::optional-->action(Action to Mermaid):::action
input2(token):::optional-->action(Action to Mermaid):::action
action(Action to Mermaid)-->output1(mermaid):::output
classDef required fill:#6ba06a,stroke:#333,stroke-width:3px
classDef optional fill:#d9b430,stroke:#333,stroke-width:3px
classDef action fill:blue,stroke:#333,stroke-width:3px,color:#ffffff
classDef output fill:#fff,stroke:#333,stroke-width:3px,color:#333
Example usage
name: Mermaid
on:
# Upon push to action.yml in the main branch
push:
branches: [ main ]
paths:
- action.yml
# Or upon manual trigger
workflow_dispatch:
jobs:
mermaid:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Get Mermaid diagram for the action repository this workflow runs in
# Use `nwo` option to change the action repository
- name: Get Mermaid diagram
id: mermaid
uses: imjohnbo/action-to-mermaid@v0
# Do something with Mermaid diagram, e.g. update README, output to separate file, etc.
- name: Echo Mermaid diagram
env:
MERMAID: ${{ steps.mermaid.outputs.mermaid }}
run: |-
echo "$MERMAID"
Example output
```mermaid
flowchart LR
input1(nwo):::optional-->action(Action to Mermaid):::action
input2(token):::optional-->action(Action to Mermaid):::action
action(Action to Mermaid)-->output1(mermaid):::output
classDef required fill:#6ba06a,stroke:#333,stroke-width:3px
classDef optional fill:#d9b430,stroke:#333,stroke-width:3px
classDef action fill:blue,stroke:#333,stroke-width:3px,color:#ffffff
classDef output fill:#fff,stroke:#333,stroke-width:3px,color:#333
```
License
Contributing
Pull requests are welcome!
369 Dec 27, 2022
3 Dec 13, 2022
105 Jan 2, 2023
591 Aug 18, 2022
6 Feb 15, 2022
7 Nov 30, 2022
9 Dec 15, 2022
17 Dec 11, 2022
128 Jan 5, 2023
3 Oct 22, 2022