documentation #2
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] | |
workflow_dispatch: | |
inputs: | |
logLevel: | |
description: 'Log level' | |
required: true | |
default: 'warning' | |
# Allow running the workflow manually from the Actions tab | |
#workflow_dispatch: | |
# Allow GITHUB_TOKEN to deploy to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow one concurrent deployment | |
concurrency: | |
group: pages | |
cancel-in-progress: true | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Configure GitHub Pages | |
uses: actions/configure-pages@v4 | |
- name: Cache phpDocumentor build files | |
id: phpdocumentor-cache | |
uses: actions/cache@v3 | |
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 -vv --target docs --cache-folder .phpdoc/cache | |
- 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 |