{"id":5800782,"name":"impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","ecosystem":"actions","description":"GitHub action to generate PHP project documentation in MarkDown format. Based on clean/phpdoc-md library.","homepage":"","licenses":"mit","normalized_licenses":["MIT"],"repository_url":"https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","keywords_array":["documentation","generator","github-actions","hacktoberfest","php"],"namespace":"impresscms-dev","versions_count":18,"first_release_published_at":"2022-06-18T20:51:46.000Z","latest_release_published_at":"2024-05-01T17:33:43.000Z","latest_release_number":"v1.0.4","last_synced_at":"2026-05-12T21:16:34.889Z","created_at":"2023-01-04T12:26:43.266Z","updated_at":"2026-05-12T21:16:34.890Z","registry_url":"https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","install_command":null,"documentation_url":null,"metadata":{"name":"Generate PHP docs with clean/phpdoc-md","description":"GitHub action to generate PHP project documentation in MarkDown format. Based on clean/phpdoc-md library.","branding":{"icon":"book","color":"blue"},"inputs":{"output_path":{"description":"Path where to write generated documentation","required":true},"class_root_namespace":{"description":"Root class namespace","required":true},"included_classes":{"description":"Included classes list (supports glob style wildcards syntax; each line means one rule)","required":true}},"runs":{"using":"composite","steps":[{"name":"Setting env variables...","env":{"GENERATOR_TMP_SUFIX":"${{ github.sha }}-${{ github.run_id }}-${{ github.github.run_attempt }}","GENERATOR_TMP_PATH":"${{ runner.temp }}","ACTION_BIN_PATH":"${{ github.action_path }}/bin"},"run":"$ACTION_BIN_PATH/generate-env.sh \"$GENERATOR_TMP_SUFIX\" \"$GENERATOR_TMP_PATH\" \"$ACTION_BIN_PATH\" \u003e\u003e $GITHUB_ENV","shell":"bash"},{"name":"Creating tmp folders","run":"$ACTION_BIN_PATH/create-temp-folders.sh","shell":"bash"},{"name":"Copying current project to tmp folder...","run":"$ACTION_BIN_PATH/copy-current-project-to-tmp-folder.sh","shell":"bash"},{"name":"Getting PHP class list...","uses":"impresscms-dev/generate-php-project-classes-list-file-action@v1.0.2","with":{"output_file":"${{ env.PHP_CLASSES_ORIG_FILE }}"}},{"name":"Generating temp filtering rules file...","uses":"DamianReeves/write-file-action@v1.3","with":{"path":"${{ env.RULES_FILE }}","contents":"${{ inputs.included_classes }}","write-mode":"overwrite"}},{"name":"Filtering PHP classes list...","uses":"impresscms-dev/filter-php-class-list-with-glob-like-rules-action@v1.1.1","with":{"rules_file":"${{ env.RULES_FILE }}","input_file":"${{ env.PHP_CLASSES_ORIG_FILE }}","output_file":"${{ env.PHP_CLASSES_FILTERED_FILE }}"}},{"name":"Generating generator config...","env":{"PHPDOCMD_FILE":"${{ env.COPY_DATA_PATH }}/.phpdoc-md","CLASS_ROOT_NAMESPACE":"${{ inputs.class_root_namespace }}","DOCS_PATH":"${{ inputs.output_path }}"},"run":"$ACTION_BIN_PATH/generate-config.php \"$PHPDOCMD_FILE\" \"$PHP_CLASSES_FILTERED_FILE\" \"$CLASS_ROOT_NAMESPACE\" \"$DOCS_PATH\"","shell":"bash"},{"name":"Including documentation generator...","run":"$ACTION_BIN_PATH/add-composer-packages.sh","shell":"bash"},{"name":"Generating documentation...","run":"$ACTION_BIN_PATH/generate-docs.sh","shell":"bash"},{"name":"Deleting tmp data...","run":"$ACTION_BIN_PATH/delete-temp-folders.sh","shell":"bash"}]},"default_branch":"main","path":null},"repo_metadata":{"id":40731920,"uuid":"504679331","full_name":"impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","owner":"impresscms-dev","description":"GitHub action to generate PHP project documentation with clean/phpdoc-md library","archived":false,"fork":false,"pushed_at":"2025-09-02T10:37:41.000Z","size":152,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-02T15:54:27.099Z","etag":null,"topics":["documentation","generator","github-actions","hacktoberfest","php"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/impresscms-dev.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,"zenodo":null}},"created_at":"2022-06-17T21:44:31.000Z","updated_at":"2025-09-02T10:30:15.000Z","dependencies_parsed_at":"2023-12-01T18:29:01.431Z","dependency_job_id":"24fb2254-19b9-4743-a093-4f12366420c3","html_url":"https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","commit_stats":{"total_commits":45,"total_committers":2,"mean_commits":22.5,"dds":"0.24444444444444446","last_synced_commit":"6d62eab81bdcaf199798e4c03694ce77a31c2355"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/impresscms-dev","download_url":"https://codeload.github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/sbom","scorecard":{"id":486235,"data":{"date":"2025-08-11","repo":{"name":"github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","commit":"011be3eb761781ed9d6a7953d03e3a5de209f586"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Maintained","score":8,"reason":"10 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/autorelease.yml:1","Warn: no topLevel permission defined: .github/workflows/on-pull-request.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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/1 approved changesets -- score normalized to 0","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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/autorelease.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/autorelease.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T17:52:58.830Z","repository_id":40731920,"created_at":"2025-08-19T17:52:58.830Z","updated_at":"2025-08-19T17:52:58.830Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273355648,"owners_count":25090825,"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","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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"},"owner_record":{"login":"impresscms-dev","name":"ImpressCMS.dev","uuid":"61651785","kind":"organization","description":"Tools and services that is used for developing ImpressCMS","email":null,"website":"https://impresscms.dev","location":null,"twitter":null,"company":null,"icon_url":"https://avatars.githubusercontent.com/u/61651785?v=4","repositories_count":11,"last_synced_at":"2023-03-04T00:39:29.449Z","metadata":{"has_sponsors_listing":false},"html_url":"https://github.com/impresscms-dev","funding_links":[],"total_stars":null,"followers":null,"following":null,"created_at":"2022-11-14T07:07:53.780Z","updated_at":"2023-03-04T00:39:29.528Z","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/impresscms-dev","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/impresscms-dev/repositories"},"tags":[]},"repo_metadata_updated_at":"2025-09-02T21:43:02.565Z","dependent_packages_count":0,"downloads":null,"downloads_period":null,"dependent_repos_count":1,"rankings":{"downloads":null,"dependent_repos_count":24.753604816986215,"dependent_packages_count":0.0,"stargazers_count":48.29028680082396,"forks_count":35.113294248138175,"docker_downloads_count":null,"average":27.039296466487087},"purl":"pkg:githubactions/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","advisories":[],"docker_usage_url":"https://docker.ecosyste.ms/usage/actions/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","docker_dependents_count":null,"docker_downloads_count":null,"usage_url":"https://repos.ecosyste.ms/usage/actions/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","dependent_repositories_url":"https://repos.ecosyste.ms/api/v1/usage/actions/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/dependencies","status":null,"funding_links":[],"critical":null,"issue_metadata":{"last_synced_at":"2025-09-02T14:01:15.333Z","issues_count":2,"pull_requests_count":76,"avg_time_to_close_issue":47.0,"avg_time_to_close_pull_request":57830.48684210526,"issues_closed_count":1,"pull_requests_closed_count":76,"pull_request_authors_count":2,"issue_authors_count":1,"avg_comments_per_issue":0.5,"avg_comments_per_pull_request":0.13157894736842105,"merged_pull_requests_count":76,"bot_issues_count":2,"bot_pull_requests_count":61,"past_year_issues_count":2,"past_year_pull_requests_count":8,"past_year_avg_time_to_close_issue":47.0,"past_year_avg_time_to_close_pull_request":75674.5,"past_year_issues_closed_count":1,"past_year_pull_requests_closed_count":8,"past_year_pull_request_authors_count":2,"past_year_issue_authors_count":1,"past_year_avg_comments_per_issue":0.5,"past_year_avg_comments_per_pull_request":0.5,"past_year_bot_issues_count":2,"past_year_bot_pull_requests_count":7,"past_year_merged_pull_requests_count":8,"issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/issues","maintainers":[],"active_maintainers":[]},"versions_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/versions","version_numbers_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/version_numbers","latest_version_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/latest_version","dependent_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/dependent_packages","related_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/related_packages","codemeta_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/impresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/codemeta","maintainers":[]}