/generate-c4-model-action

GitHub Action for generating C4 model images

Primary LanguageShellMIT LicenseMIT

Generate C4 Model

This action takes your C4 model system architecture in Structurizr DSL format and generates PlantUML .png images for it.

Inputs

source-path

Required The path to the Structurizr DSL file.

target-path

Required The path to the directory in which to place the C4 model artifacts. Default .github/actions/dist

Example usage

- name: Generate C4 Model
  uses:  university-of-york/generate-c4-model-action@1.0.0
  with:
    source-path: docs/c4-model.dsl
    target-path: .github/actions/dist/images/c4

Mentions

Thanks to Structurizr Limited for the Structurizr DSL and Structurizr CLI.

Licence

The scripts and documentation in this project are released under the MIT License