You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
ApiGen Docs
2.0
Simple Github Action Which Helps You To Generate PHP Code Documentation Website Using ApiGen
| Argument | Default | Description |
|---|---|---|
push_to_branch |
gh-pages | Which Branch To Push |
before_cmd |
null | Option to run custom cmd before generating docs |
after_cmd |
null | Option to run custom cmd after generating docs |
auto_push |
Yes | If set the Yes then it auto pushes generated files to current github repo to the branch defined in push_to_branch |
output_folder |
null | This option can be used to provide custom output folder if auto_push is disabled |
source_folder |
null | This option can be used to provide custom source folder if auto_push is disabled |
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
name: ON_PUSH
on:
push:
branches:
- master
jobs:
Document_Generator:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: 📝 ApiGen PHP Document Generator
uses: varunsridharan/action-apigen@2.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
If you would like to help, please take a look at the list of issues or the To Do checklist.
Our GitHub Actions are available for use and remix under the MIT license.
2017 - 2018 Varun Sridharan, varunsridharan.in
If you find it useful, let me know 😉
You can contact me on Twitter or through my email.
 |
 |
 |
|---|