{"id":38749232,"url":"https://github.com/kcirtapfromspace/plantuml","last_synced_at":"2026-01-17T11:48:29.221Z","repository":{"id":117384100,"uuid":"501287890","full_name":"kcirtapfromspace/plantuml","owner":"kcirtapfromspace","description":"A docker container to run plantuml ","archived":false,"fork":false,"pushed_at":"2025-03-14T07:02:38.000Z","size":152,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-12T09:39:04.556Z","etag":null,"topics":["c4-model","docker-image","plantuml","plantuml-server"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kcirtapfromspace.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-08T14:32:49.000Z","updated_at":"2024-02-01T05:48:28.000Z","dependencies_parsed_at":"2025-03-14T10:31:19.408Z","dependency_job_id":null,"html_url":"https://github.com/kcirtapfromspace/plantuml","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kcirtapfromspace/plantuml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kcirtapfromspace%2Fplantuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kcirtapfromspace%2Fplantuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kcirtapfromspace%2Fplantuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kcirtapfromspace%2Fplantuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kcirtapfromspace","download_url":"https://codeload.github.com/kcirtapfromspace/plantuml/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kcirtapfromspace%2Fplantuml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28508459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c4-model","docker-image","plantuml","plantuml-server"],"created_at":"2026-01-17T11:48:28.686Z","updated_at":"2026-01-17T11:48:29.206Z","avatar_url":"https://github.com/kcirtapfromspace.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fast \u0026 Easy C4 Diagrams with PlantUML\n\n## Why C4 Diagrams\n\nThe C4 model is an easy to learn, developer friendly approach to software architecture diagramming. Good software architecture diagrams assist with communication inside/outside of software development/product teams, efficient onboarding of new staff, architecture reviews/evaluations, risk identification (e.g. risk-storming), threat modelling (e.g. STRIDE/LINDDUN), etc.\n\n\u003chttps://c4model.com/\u003e\n\n## Why PlantUML\n\nWith [PlantUML](https://plantuml.com/) C4 diagrams are breeze to mock out.\n\n## Local Setup\nSetup a local alias\n```sh\necho -n \"alias plantuml='docker run -v $(pwd)/doc/design/assets/:/assets plantuml'\" \u003e\u003e ~/.zshrc\n```\n## Generate PlantUML Diagrams GitHub Action\nThis GitHub Action automatically generates PlantUML diagrams and commits them back to your repository whenever there's a change in the specified directories containing PlantUML files.\n\n### Prerequisites\nEnsure that you have a Docker container that can generate PlantUML diagrams. This action assumes using the container for the repo ghcr.io/kcirtapfromspace/plantuml/plantuml:latest\n\nThe container should be available on a container registry like Docker Hub or GitHub Container Registry.\n\nUsage\nTo use this action, follow these steps:\n\nCreate a .github/workflows directory in your repository if it doesn't already exist.\n\nCreate a new file in the .github/workflows directory named plantuml.yml.\n\nCopy the contents below into the plantuml.yml file:\n\n```yaml\nname: Generate PlantUML diagrams\n\non:\n  push:\n    paths:\n      - 'doc/design/**'\n  pull_request:\n    paths:\n      - 'doc/design/**'\n\njobs:\n  generate-diagrams:\n    runs-on: ubuntu-latest\n\n    steps:\n    - name: Checkout repository\n      uses: actions/checkout@v2\n      with:\n        fetch-depth: 0\n\n    - name: Generate PlantUML diagrams\n      run: |\n        docker run --rm -v ${{ github.workspace }}/doc/design/assets:/assets ghcr.io/kcirtapfromspace/plantuml/plantuml:latest\n\n    - name: Set up Git user\n      run: |\n        git config --local user.email \"github-actions@users.noreply.github.com\"\n        git config --local user.name \"GitHub Actions\"\n\n    - name: Commit generated diagrams\n      run: |\n        git add doc/design/assets\n        git diff-index --quiet HEAD || git commit -m \"Update generated PlantUML diagrams\"\n        git push\n```\n### Customization\nTo customize the action, you can modify the plantuml.yml file:\n\nChange the paths option in the on section to watch different directories for changes.\nUpdate the container name in the run command if you use a different container for generating PlantUML diagrams.\nModify the commit message in the \"Commit generated diagrams\" step by changing the text within the quotes after -m.\nRemember to commit and push any changes to the plantuml.yml file for the modifications to take effect.\n\n## Design Guide \nSee the [design guide] for a quick example\n\n[design guide]: doc/design/design.md \"Optional Title Here\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkcirtapfromspace%2Fplantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkcirtapfromspace%2Fplantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkcirtapfromspace%2Fplantuml/lists"}