Merge #684 #159
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: documentation | |
| on: | |
| push: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| DOCUMENTATION_TITLE: "Meilisearch PHP | Documentation" | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Cache phpDocumentor build files | |
| id: phpdocumentor-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: .phpdoc/cache | |
| key: ${{ runner.os }}-phpdocumentor-${{ github.sha }} | |
| restore-keys: | | |
| ${{ runner.os }}-phpdocumentor- | |
| - name: Build with phpDocumentor | |
| run: docker run --rm --volume "$(pwd):/data" phpdoc/phpdoc:3 -d /data -i tests/ -vv --target /data/docs --cache-folder /data/.phpdoc/cache --template default --title "$DOCUMENTATION_TITLE" | |
| - name: Upload artifact to GitHub Pages | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs | |
| deploy: | |
| needs: build | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |