https://github.com/robbell/plantuml-docker

Run PlantUML in a Docker container as part of your build pipeline
https://github.com/robbell/plantuml-docker

architecture architecture-diagrams azure-devops azure-devops-pipelines c4 c4model cicd docker help-wanted plantuml

Last synced: 6 days ago
JSON representation

Run PlantUML in a Docker container as part of your build pipeline

• Host: GitHub
• URL: https://github.com/robbell/plantuml-docker
• Owner: robbell
• License: mit
• Created: 2020-02-09T18:01:08.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-21T04:02:36.000Z (over 3 years ago)
• Last Synced: 2024-08-02T16:35:05.679Z (3 months ago)
• Topics: architecture, architecture-diagrams, azure-devops, azure-devops-pipelines, c4, c4model, cicd, docker, help-wanted, plantuml
• Language: Dockerfile
• Homepage:
• Size: 8.79 KB
• Stars: 11
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PlantUML in Docker

Run PlantUML in a Docker container. For use as part of your build pipeline.

![Docker Build Status](https://img.shields.io/docker/cloud/build/robbell/plantuml-docker?style=for-the-badge)

## Usage

### Multiple files by wildcard

Where all PlantUML files exist in the `path-to-mount` folder and have the extension .puml:

```

docker run -v path-to-mount:/source --rm -i robbell/plantuml-docker source/*.puml -o ./output

```

### Single file

```

cat sample.puml | docker run --rm -i robbell/plantuml-docker > output.png

```

### Azure DevOps Pipeline

```

trigger:

- master

pool:

  vmImage: 'ubuntu-latest'

steps:

- script: docker run -v $(Build.Repository.LocalPath)/plantuml:/source --rm -i robbell/plantuml-docker source/*.puml -o ./output

  displayName: 'Export PlantUML diagrams'

- task: PublishBuildArtifacts@1

  displayName: 'Publish PlantUML diagrams as artifact'

  inputs:

    PathtoPublish: '$(Build.Repository.LocalPath)/plantuml/output'

    ArtifactName: 'plantuml-output'

```

## Upcoming

- [x] Include Azure Devops sample tasks

- [ ] Include more samples for PNG and SVG, and wildcard usage

- [ ] List the benefits vs. PlantUML Server