-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
efb4119
commit 71599f9
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: documentation | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
|
||
# 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@v3 | ||
- name: Configure GitHub Pages | ||
uses: actions/configure-pages@v1 | ||
- 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 --template default | ||
- name: Upload artifact to GitHub Pages | ||
uses: actions/upload-pages-artifact@v1 | ||
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@v1 |