Skip to content

Commit

Permalink
Workflow to publish phpdoc to github pages (#1418)
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm authored Oct 27, 2024
1 parent 93f2068 commit 1aae9dd
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/phpdoc-to-github-pages
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1aae9dd

Please sign in to comment.