{"id":17106047,"url":"https://github.com/grassedge/generate-plantuml-action","last_synced_at":"2025-04-05T10:10:11.460Z","repository":{"id":40291035,"uuid":"226627344","full_name":"grassedge/generate-plantuml-action","owner":"grassedge","description":"Generate uml diagrams with Plantuml Server and push them to your repository.","archived":false,"fork":false,"pushed_at":"2024-06-18T04:55:06.000Z","size":924,"stargazers_count":110,"open_issues_count":20,"forks_count":166,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T09:10:14.819Z","etag":null,"topics":["github-actions","plantuml","uml-diagrams"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/grassedge.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":"2019-12-08T06:53:26.000Z","updated_at":"2024-12-29T20:58:31.000Z","dependencies_parsed_at":"2023-02-03T06:16:08.575Z","dependency_job_id":"a3b57407-a071-4e04-8d26-ab5113f47ac1","html_url":"https://github.com/grassedge/generate-plantuml-action","commit_stats":{"total_commits":70,"total_committers":6,"mean_commits":"11.666666666666666","dds":0.5571428571428572,"last_synced_commit":"1e7d7fd8d255356e8dcc48ee340ba517491e362f"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grassedge%2Fgenerate-plantuml-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grassedge%2Fgenerate-plantuml-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grassedge%2Fgenerate-plantuml-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grassedge%2Fgenerate-plantuml-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grassedge","download_url":"https://codeload.github.com/grassedge/generate-plantuml-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247117734,"owners_count":20886439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["github-actions","plantuml","uml-diagrams"],"created_at":"2024-10-14T15:43:49.425Z","updated_at":"2025-04-05T10:10:11.431Z","avatar_url":"https://github.com/grassedge.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maintainability](https://api.codeclimate.com/v1/badges/a21c7671c0a7ae182c28/maintainability)](https://codeclimate.com/github/grassedge/generate-plantuml-action/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/a21c7671c0a7ae182c28/test_coverage)](https://codeclimate.com/github/grassedge/generate-plantuml-action/test_coverage)\n[![Actions Status](https://github.com/grassedge/generate-plantuml-action/workflows/tests/badge.svg)](https://github.com/grassedge/generate-plantuml-action/actions)\n\n# generate-plantuml-action\n\nGenerate uml diagrams with Plantuml Server and push them to your repository.\n\nThis action ease you to maintain UML.\nUML is very useful, but there are some difficulties to maintain.\n[PlantUML](https://plantuml.com/) enables you to write UML with text code, that is engineer-friendly so you would like it.\n\nThis actions generate UML diagrams from plantuml code\nwith [PlantUML Server](https://plantuml.com/en/server) when you commit plantUML files\nor Markdown files that plantuml code is written in.\n\nPlantUML files must end in either of\n- `.pu`\n- `.pml`\n- `.puml`\n- `.plantuml`\n\nMarkdown files must end in\n- `.md`\n- `.markdown`\n- `.mdown`\n- `.mkdn`\n- `.mdwn`\n- `.mkd`\n- `.mdn`\n- `.md.txt`\n\n## Usage\n\nThis Action subscribes to Push events.\n\n```workflow\nname: generate plantuml\non: push\njobs:\n  generate_plantuml:\n    runs-on: ubuntu-latest\n    name: plantuml\n    steps:\n    - name: checkout\n      uses: actions/checkout@v1\n      with:\n        fetch-depth: 1\n    - name: plantuml\n      id: plantuml\n      uses: grassedge/generate-plantuml-action@v1.5\n      with:\n        path: example\n        message: \"Render PlantUML files\"\n      env:\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n*input*\n\n- `path` : specify the path to save generated svg files  \n  the default (`.`) saves each SVG file in the same folder as the source\n  file it was generated from\n- `message` : specify the commit message for the commit of generated\n  svg files (defaults to `Render PlantUML files`)\n\n*env*\n\n- `GITHUB_TOKEN` : *required* GitHub Token of your repository to commit svg files.\n\n## Demo\n\nsee [examples](./example/sample.md) here.\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrassedge%2Fgenerate-plantuml-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrassedge%2Fgenerate-plantuml-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrassedge%2Fgenerate-plantuml-action/lists"}