{"id":22468999,"url":"https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action","last_synced_at":"2025-09-14T15:58:48.129Z","repository":{"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":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":275128934,"owners_count":25410374,"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-14T02:00:10.474Z","response_time":75,"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"}},"keywords":["documentation","generator","github-actions","hacktoberfest","php"],"created_at":"2024-12-06T11:24:56.446Z","updated_at":"2025-09-14T15:58:48.071Z","avatar_url":"https://github.com/impresscms-dev.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License](https://img.shields.io/github/license/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action.svg)](LICENSE)\n[![GitHub release](https://img.shields.io/github/release/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action.svg)](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action/releases)\n\n# Generate PHP docs with clean/phpdoc-md\n\nGitHub action to generate PHP project documentation in [MarkDown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) format. Based on [clean/phpdoc-md](https://github.com/clean/phpdoc-md) library.\n\n## Usage\n\nTo use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):\n```yaml\nname: Generate documentation\n\non:\n  push:\n\njobs:\n  get_php_classes_list:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkouting project code...\n        uses: actions/checkout@v2\n        \n      - name: Install PHP\n        uses: shivammathur/setup-php@v2.2\n        with:\n          php-version: 8.1\n          extensions: curl, gd, pdo_mysql, json, mbstring, pcre, session\n          ini-values: post_max_size=256M\n          coverage: none\n          tools: composer:v2\n          \n      - name: Install Composer dependencies (with dev)\n        run: composer install --no-progress --prefer-dist --optimize-autoloader\n          \n      - name: Generating documentation...\n        uses: impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action@v1.0.0\n        with:\n          class_root_namespace: ImpressCMS\\\n          included_classes: ImpressCMS\\**\n          output_path: ./docs/\n          \n      - uses: actions/upload-artifact@v3\n        with:\n          name: my-artifact\n          path: ./docs/\n```\n\n## Arguments \n\nThis action supports such arguments (used in `with` keyword):\n| Argument    | Required | Default value        | Description                       |\n|-------------|----------|----------------------|-----------------------------------|\n| output_path | Yes      |                      | Path where to write generated documentation |\n| class_root_namespace | Yes      |                      | Root class namespace |\n| included_classes | Yes      |                      | Included classes list (supports glob style wildcards syntax; each line means one rule) |\n\n## How to contribute? \n\nIf you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try [interactive GitHub tutorial](https://skills.github.com).\n\nIf you found any bug or have some questions, use [issues tab](https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/issues) and write there your questions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimpresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpresscms-dev%2Fgenerate-phpdocs-with-clean-phpdoc-md-action/lists"}