{"id":36596633,"url":"https://github.com/talsma-ict/umldoclet","last_synced_at":"2026-01-12T08:30:18.404Z","repository":{"id":5338456,"uuid":"52003734","full_name":"talsma-ict/umldoclet","owner":"talsma-ict","description":"Automatically generate PlantUML diagrams in javadoc","archived":false,"fork":false,"pushed_at":"2025-12-03T10:06:05.000Z","size":97154,"stargazers_count":253,"open_issues_count":16,"forks_count":31,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-12-04T01:51:57.920Z","etag":null,"topics":["code-analysis","diagram","doclet","generator","javadoc","plantuml","uml"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/talsma-ict.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":".github/contributing.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-02-18T11:49:03.000Z","updated_at":"2025-12-03T10:06:08.000Z","dependencies_parsed_at":"2023-12-30T15:25:15.623Z","dependency_job_id":"0d125d21-6734-4b94-bfe2-872019dec3df","html_url":"https://github.com/talsma-ict/umldoclet","commit_stats":{"total_commits":1058,"total_committers":10,"mean_commits":105.8,"dds":0.4272211720226843,"last_synced_commit":"40fd4b0b431a008f5dc32c40f88aafa354c5a92b"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"purl":"pkg:github/talsma-ict/umldoclet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/talsma-ict%2Fumldoclet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/talsma-ict%2Fumldoclet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/talsma-ict%2Fumldoclet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/talsma-ict%2Fumldoclet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/talsma-ict","download_url":"https://codeload.github.com/talsma-ict/umldoclet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/talsma-ict%2Fumldoclet/sbom","scorecard":{"id":111620,"data":{"date":"2025-08-04","repo":{"name":"github.com/talsma-ict/umldoclet","commit":"55c5531fbc68eb625bda291eb5aec43265eed19c"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":6.1,"checks":[{"name":"Maintained","score":10,"reason":"17 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/deploy.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":2,"reason":"Found 1/4 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: .mvn/wrapper/maven-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/build.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/talsma-ict/umldoclet/release.yml/main?enable=pin","Info:   0 out of   7 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":8,"reason":"1 out of the last 1 releases have a total of 1 signed artifacts.","details":["Info: signed release artifact: umldoclet-2.2.2-javadoc.jar.asc: https://github.com/talsma-ict/umldoclet/releases/tag/2.2.2","Warn: release artifact 2.2.2 does not have provenance: https://api.github.com/repos/talsma-ict/umldoclet/releases/229722967"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/deploy.yml:10"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":10,"reason":"SAST tool detected","details":["Info: SAST configuration detected: Sonar","Warn: 4 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-15T12:23:33.593Z","repository_id":5338456,"created_at":"2025-08-15T12:23:33.594Z","updated_at":"2025-08-15T12:23:33.594Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["code-analysis","diagram","doclet","generator","javadoc","plantuml","uml"],"created_at":"2026-01-12T08:30:12.801Z","updated_at":"2026-01-12T08:30:18.384Z","avatar_url":"https://github.com/talsma-ict.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maven Version][maven-img]][maven]\n[![Javadoc][javadoc-img]][javadoc]\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=talsma-ict_umldoclet\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=talsma-ict_umldoclet)\n[![Coverage Status][coveralls-img]][coveralls]\n\n# UMLDoclet\n\n[Doclet for javadoc][doclet] to automatically add [UML diagrams][plantuml] to Java documentation.  \n\n## Generate UML diagrams\n\nThe UML Doclet uses available javadoc metadata to automatically generate\nthe following UML diagrams and embeds them in your HTML documentation.\nThe diagrams are embedded as clickable SVG objects by default \nand link to package and class documentation where available.\n\n### Package dependency diagram\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://www.javadoc.io/doc/nl.talsmasoftware/umldoclet\"\u003e\u003cimg src=\"https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.2.3/package-dependencies.svg\" width=\"60%\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n_The UML Doclet will warn about (and optionally fail on) cyclic package dependencies._\n\nThe dependency diagram links to package documentation containing:\n\n### Package diagram\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/package-summary.html\"\u003e\u003cimg src=\"https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.2.3/nl/talsmasoftware/umldoclet/rendering/indent/package.svg\" width=\"60%\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\nThe package diagram links to class documentation containing:\n\n### Class diagram\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.html\"\u003e\u003cimg src=\"https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.2.3/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.svg\" height=\"200\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n(These examples are from the [latest UML Doclet javadoc][javadoc] page. Please feel free to take a look to get an idea of the final result)\n\n## Requirements\n\nTo use the UML Doclet, the following is required.\n\n- [Javadoc version 9][doclet] or higher.  \n  For versions of javadoc from earlier JDKs, please use the [latest `1.x` UML Doclet version][v1.x].\n  If you compile your java 8 or older javadocs with a more recent JDK (Javadoc version 9 or higher),\n  you need to use the 2.x version.\n- The UML Doclet, the [usage page][usage] shows how.\n  An apache-licensed version of [PlantUML][plantuml] is already included in the umldoclet jar.\n\n## Releases\n\nReleased versions can be found in the [maven central repository][maven]\nor on [github](https://github.com/talsma-ict/umldoclet/releases).  \n\n## Usage\n\n- Please see the separate [usage page][Usage]\n  on how to use the UML Doclet in your own Java projects.\n\n## Feedback\n\n- We welcome [new issues](https://github.com/talsma-ict/umldoclet/issues/new).\n  Please search the [current issues](https://github.com/talsma-ict/umldoclet/issues)\n  to avoid filing a duplicate.\n- If at all possible, please provide an example when sending in bugs.\n  This will make fixing them that much easier!\n  \n## Contributing\n\n- See [the contribute page](https://github.com/talsma-ict/umldoclet/contribute) for this repository.\n\n## Thanks\n\n- First of all a big thanks to [Arnaud Roques](https://github.com/arnaudroques),\n  the developer of the excellent [PlantUML project](https://github.com/plantuml/plantuml) \n  without whom this project wouldn't exist!\n- And of course thank _you_ for using UML Doclet.\n  I hope it may be of benefit to your project!\n\n## License\n\n- [Apache 2.0 license](./LICENSE)\n\n  [coveralls-img]: \u003chttps://coveralls.io/repos/github/talsma-ict/umldoclet/badge.svg\u003e\n  [coveralls]: \u003chttps://coveralls.io/github/talsma-ict/umldoclet\u003e\n  [codacy-img]: \u003chttps://api.codacy.com/project/badge/Grade/b191c058492e466cb7044c1d53123d9a\u003e\n  [codacy]: \u003chttps://www.codacy.com/app/talsma-ict/umldoclet?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=talsma-ict/umldoclet\u0026amp;utm_campaign=Badge_Grade\u003e\n  [maven-img]: \u003chttps://img.shields.io/maven-central/v/nl.talsmasoftware/umldoclet\u003e\n  [maven]: \u003chttp://mvnrepository.com/artifact/nl.talsmasoftware/umldoclet\u003e\n  [javadoc-img]: \u003chttps://www.javadoc.io/badge/nl.talsmasoftware/umldoclet.svg\u003e\n  [javadoc]: \u003chttps://www.javadoc.io/doc/nl.talsmasoftware/umldoclet\u003e\n  \n  [usage]: \u003cusage.md\u003e\n  [v1.x]: \u003chttps://github.com/talsma-ict/umldoclet/tree/develop-v1\u003e\n  [plantuml]: \u003chttp://plantuml.com\u003e\n  [doclet]: \u003chttps://docs.oracle.com/javase/9/docs/api/jdk/javadoc/doclet/Doclet.html\u003e\n  [libexpat]: \u003chttps://github.com/libexpat/libexpat/releases\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftalsma-ict%2Fumldoclet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftalsma-ict%2Fumldoclet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftalsma-ict%2Fumldoclet/lists"}