{"id":22468989,"url":"https://github.com/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action","last_synced_at":"2026-04-18T17:01:46.550Z","repository":{"id":37607834,"uuid":"505996895","full_name":"impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action","owner":"impresscms-dev","description":"GitHub action to generate PHP project documentation with evert/phpdoc-md library","archived":false,"fork":false,"pushed_at":"2026-03-27T03:39:57.000Z","size":128,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-27T13:12:19.844Z","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-21T20:39:17.000Z","updated_at":"2026-03-27T03:39:22.000Z","dependencies_parsed_at":"2023-02-17T03:15:16.737Z","dependency_job_id":"465564c4-650c-426a-8ff0-b305614e8256","html_url":"https://github.com/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-evert-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-evert-phpdoc-md-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action/sbom","scorecard":{"id":486236,"data":{"date":"2025-08-11","repo":{"name":"github.com/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action","commit":"9d59b308389b546f360c8836e873341ddea02934"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/4 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":"Maintained","score":2,"reason":"3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"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":"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":"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":"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-evert-phpdoc-md-action/autorelease.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action/on-pull-request.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-pull-request.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/impresscms-dev/generate-phpdocs-with-evert-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":"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":"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":"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:53:00.775Z","repository_id":37607834,"created_at":"2025-08-19T17:53:00.775Z","updated_at":"2025-08-19T17:53:00.775Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31976805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T16:27:12.723Z","status":"ssl_error","status_checked_at":"2026-04-18T16:27:11.140Z","response_time":103,"last_error":"SSL_read: 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":["documentation","generator","github-actions","hacktoberfest","php"],"created_at":"2024-12-06T11:24:51.379Z","updated_at":"2026-04-18T17:01:46.544Z","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-evert-phpdoc-md-action.svg)](LICENSE)\n[![GitHub release](https://img.shields.io/github/release/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action.svg)](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action/releases)\n\n# Generate PHP docs with evert/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 [evert/phpdoc-md](https://github.com/evert/phpdoc-md) library.\n\nThis action is container-based and runs on official PHP Docker images. It does not require setting up PHP or Composer on the runner.\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: Generating documentation...\n        uses: impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action@v2\n        with:\n          php_version: '7.4'\n          output_path: ./docs/\n          ignored_files: |\n            test/\n            extras/\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| php_version | No | 7.4 | PHP version to run (accepted range: `5.4` to `7.4`, inclusive) |\n| ignored_files | No      |                      | Defines files that can be ignored (supports glob rules; each line means one rule) |\n| phpdocumentor_version | No | v2.8.5 | What [phpDocumentor](https://www.phpdoc.org) version to use (latest or release tag like `v2.8.5`) |\n| output_path | Yes | | Path where to write generated documentation |\n\n## Notes\n\n- Docker build clones `git@github.com:evert/phpdoc-md.git` directly and falls back to HTTPS clone when SSH credentials are not available.\n- phpDocumentor release artifacts are downloaded during action runtime and are not stored in this repository.\n- Dockerfile supports selecting PHP by version: `docker build --build-arg PHP_VERSION=7.4 .`\n- `php_version` input must match the container runtime version (this image version is controlled by `PHP_VERSION` build arg).\n- Tests are JavaScript integration tests based on [testcontainers-node](https://github.com/testcontainers/testcontainers-node).\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-evert-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-evert-phpdoc-md-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimpresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpresscms-dev%2Fgenerate-phpdocs-with-evert-phpdoc-md-action/lists"}