https://github.com/num30/c4-render

Github action to render mermaid based documentation from C4 diagrams written DSL
https://github.com/num30/c4-render

Last synced: 2 months ago
JSON representation

Github action to render mermaid based documentation from C4 diagrams written DSL

• Host: GitHub
• URL: https://github.com/num30/c4-render
• Owner: num30
• License: mit
• Created: 2022-06-18T10:29:37.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T17:27:18.000Z (about 2 years ago)
• Last Synced: 2026-02-11T02:30:50.153Z (5 months ago)
• Language: Shell
• Size: 37.1 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# c4-render

Github action to render markdown files from C4 diagrams written in DSL 

## How to use 

- Create a [DSL](https://github.com/structurizr/dsl/blob/master/docs/cookbook/README.md) file 

- Add C4-render step to github workflow

```

      - name: Run a one-line script    

        uses: num30/c4-render@1e3595a78a67ee5a2d7889aa3970bcfbea7b7dec

        with:

          path: diagrams #target path in the repository

          filename: diagram.dsl

```

Refer to this example: https://github.com/DenisPalnitsky/c4-rendering-sample/blob/main/README.md

### Parameters

```

  filename: 

    description: 'Diagram file name'

    required: true

  github-branch: 

    description: 'Github branch name to commit rendered diagrams'

    default: ${{ github.ref }}

    

  github-token:  

    description: "Github token to access target repository"    

    default: ${{ github.token }}

  github-repo:  

    description: > 

          Target repository with owner in form of `some-org/repo` 

    default: ${{ github.repository }}

  path:

    description: 'Relative path in target repository to place the rendered MD files'

    default: './'

  github-username:  

    description: "Username of a user that will make a commit`"

    default: C4RenderBot

  github-user-mail:  

    description: "Email of a user that will make a commit`"    

    default: 'github-bot@${{ github.repository_owner }}.com'

  

  structurizr-image-tag:

    description: Specific image tag of `structurizr/cli` docker image

    default:  latest

```