GithHub Pages #24
Workflow file for this run
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: GithHub Pages | |
| on: | |
| push: | |
| tags: | |
| - '*' | |
| permissions: {} | |
| jobs: | |
| github-pages: | |
| permissions: | |
| contents: write # to push pages branch (peaceiris/actions-gh-pages) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup PHP, with composer and extensions | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.1 | |
| coverage: none # remove xdebug | |
| - name: Build API documentation | |
| run: | | |
| curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.4.1/phpDocumentor.phar | |
| php phpDocumentor.phar --directory src/ --target docs/api | |
| - name: Deploy to GithHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/api |