Skip to content

Commit

Permalink
Create apiDocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
jkrrv authored Feb 7, 2024
1 parent 2ed8da7 commit 2a11637
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/apiDocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy API Docs content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master", "docs"]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
api-docs:

environment:
name: Generate and deploy API Docs
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}

- name: Checkout repository
uses: actions/checkout@v2

- name: Generate API docs
uses: phpDocumentor/phpDocumentor@master
with:
args: --t docs/phpApi

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload appropriate directory
path: 'docs/phpApi'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 2a11637

Please sign in to comment.