From 1aae9dd61930ac02d2936e1eda795c39c4f7a959 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Sun, 27 Oct 2024 22:27:02 +0100 Subject: [PATCH] Workflow to publish phpdoc to github pages (#1418) --- .github/workflows/phpdoc-to-github-pages | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/phpdoc-to-github-pages diff --git a/.github/workflows/phpdoc-to-github-pages b/.github/workflows/phpdoc-to-github-pages new file mode 100644 index 000000000..69334e287 --- /dev/null +++ b/.github/workflows/phpdoc-to-github-pages @@ -0,0 +1,35 @@ +name: "Generate API Documentation" + +on: + push: + branches: + - "main" + pull_request: + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +jobs: + documentation: + name: "Documentation" + runs-on: "ubuntu-latest" + steps: + - name: "Checkout" + uses: "actions/checkout@v4" + - name: "Build" + uses: "phpDocumentor/phpDocumentor@v3.5.3" + with: + target: "docs/build" + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/build' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4