{"id":16055674,"url":"https://github.com/varunsridharan/action-apigen","last_synced_at":"2025-03-17T21:31:20.153Z","repository":{"id":65162191,"uuid":"204446691","full_name":"varunsridharan/action-apigen","owner":"varunsridharan","description":"Github Action To Generate Code Docs Website For PHP Using ApiGen","archived":false,"fork":false,"pushed_at":"2020-09-30T02:42:05.000Z","size":1729,"stargazers_count":3,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-02T03:00:31.099Z","etag":null,"topics":["apigen","code-documentation","docs","github-action","github-actions","php","php-apigen","php-docs","php-documentator","vs-github-action"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/apigen-docs","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/varunsridharan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-26T09:54:00.000Z","updated_at":"2020-09-30T02:42:08.000Z","dependencies_parsed_at":"2023-01-04T12:39:06.257Z","dependency_job_id":null,"html_url":"https://github.com/varunsridharan/action-apigen","commit_stats":{"total_commits":99,"total_committers":2,"mean_commits":49.5,"dds":0.02020202020202022,"last_synced_commit":"686ece44c1d62d2e82d127e870d37c7f63f82066"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Faction-apigen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Faction-apigen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Faction-apigen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Faction-apigen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varunsridharan","download_url":"https://codeload.github.com/varunsridharan/action-apigen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243885990,"owners_count":20363649,"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":["apigen","code-documentation","docs","github-action","github-actions","php","php-apigen","php-docs","php-documentator","vs-github-action"],"created_at":"2024-10-09T02:21:26.302Z","updated_at":"2025-03-17T21:31:18.714Z","avatar_url":"https://github.com/varunsridharan.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ApiGen - ***Github Action***\nSimple Github Action Which Helps You To Generate PHP Code Documentation Website Using ApiGen\n\n## Configuration\n| Argument | Default | Description |\n| --- | ------- | ----------- |\n|`push_to_branch` | gh-pages | Which Branch To Push |\n|`before_cmd` | null | Option to run custom cmd before generating docs |\n|`after_cmd` | null | Option to run custom cmd after generating docs |\n|`auto_push` | Yes | if `Yes` then auto pushes files to current repo to the branch defined in `push_to_branch` |\n|`output_folder` | null | Custom output folder if `auto_push` is disabled |\n|`source_folder` | null | Custom source folder if `auto_push` is disabled |\n|`cached_apigen` | yes |  Set yes to reduce runtime load |\n---\n\n\u003e **Note** Provide A Branch Which is only for the docs. if any other contents in it then all will be deleted **DO NOT USE : MASTER**  \n\n## Cached Stats\n***Cache is useful when running in private repo or if you want to reduce load in github servers*** \n\n### With Cache\n\u003e With cached enabled workflow takes only around **25s** to **35s**\n\n![https://raw.githubusercontent.com/varunsridharan/action-apigen/master/assets/with-cache.jpg](https://raw.githubusercontent.com/varunsridharan/action-apigen/master/assets/with-cache.jpg)\n\n### Without Cache\n\u003e if cached disabled then workflow takes around **45s** to **55s**\n\n![https://raw.githubusercontent.com/varunsridharan/action-apigen/master/assets/without-cache.jpg](https://raw.githubusercontent.com/varunsridharan/action-apigen/master/assets/without-cache.jpg)\n\n\n## Example Workflow File\n\n## Without Local Cache\n```yaml\nname: ON_PUSH\n\non:\n  push:\n    branches:\n      - master\n\njobs:\n  Document_Generator:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - name: 📝 ApiGen PHP Document Generator\n      uses: varunsridharan/action-apigen@2.0\n      with:\n        cached_apigen: 'no'\n      env:\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Local Cache\n```yaml\nname: ON_PUSH\n\non:\n  push:\n    branches:\n      - master\n\njobs:\n  Document_Generator:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - name: 📝 ApiGen PHP Document Generator\n      uses: varunsridharan/action-apigen@2.0\n      with:\n        cached_apigen: 'yes'\n      env:\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        \n```\n\n---\n## Contribute\nIf you would like to help, please take a look at the list of\n[issues][issues] or the [To Do](#-todo) checklist.\n\n## License\nOur GitHub Actions are available for use and remix under the MIT license.\n\n## Copyright\n2017 - 2018 Varun Sridharan, [varunsridharan.in][website]\n\nIf you find it useful, let me know :wink:\n\nYou can contact me on [Twitter][twitter] or through my [email][email].\n\n## Backed By\n| [![DigitalOcean][do-image]][do-ref] | [![JetBrains][jb-image]][jb-ref] |  [![Tidio Chat][tidio-image]][tidio-ref] |\n| --- | --- | --- |\n\n[twitter]: https://twitter.com/varunsridharan2\n[email]: mailto:varunsridharan23@gmail.com\n[website]: https://varunsridharan.in\n[issues]: issues/\n\n[do-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/DO_Logo_Horizontal_Blue-small.png\n[jb-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/phpstorm-small.png?v3\n[tidio-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/tidiochat-small.png\n[do-ref]: https://s.svarun.in/Ef\n[jb-ref]: https://www.jetbrains.com\n[tidio-ref]: https://tidiochat.com\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Faction-apigen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarunsridharan%2Faction-apigen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Faction-apigen/lists"}