Customize phpdoc template #20
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate PHP Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: '8.1' | |
| - name: Install phpDocumentor | |
| run: | | |
| wget https://phpdoc.org/phpDocumentor.phar | |
| chmod +x phpDocumentor.phar | |
| sudo mv phpDocumentor.phar /usr/local/bin/phpdoc | |
| - name: Generate Documentation | |
| run: phpdoc -d ./src -t ./docs | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v5 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: Update documentation | |
| title: 'Update PHP documentation' | |
| body: | | |
| This PR updates the PHP documentation. | |
| - Generated using phpDocumentor | |
| - Auto-generated by [create-pull-request][1] | |
| [1]: https://github.com/peter-evans/create-pull-request | |
| branch: update-php-docs | |
| base: ${{ github.head_ref || github.ref_name }} | |
| delete-branch: true |