⚠️ Note: To use this GitHub Action, you must have access to GitHub Actions. GitHub Actions are currently only available in public beta. You can apply for Github Actions beta access here.

ApiGen - Github Action

Github Action To Generate Code Docs Website For PHP Using ApiGen

Configuration

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

---

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

Example Workflow File

name: ApiGen

on: [push]

jobs:
  apigen:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: ApiGen Docs Generator
      uses: varunsridharan/action-apigen@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        

---

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

License

Our GitHub Actions are available for use and remix under the MIT license.

Copyright

2017 - 2018 Varun Sridharan, varunsridharan.in

If you find it useful, let me know 😉

You can contact me on Twitter or through my email.

Backed By