Publish API docs via GitHub Actions
This commit is contained in:
parent
df2fd911d0
commit
c3d1ce536b
|
@ -0,0 +1,29 @@
|
|||
name: GithHub Pages
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
github-pages:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Setup PHP, with composer and extensions
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: 7.4
|
||||
coverage: none # remove xdebug
|
||||
|
||||
- name: Build API documentation
|
||||
run: |
|
||||
curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
|
||||
php phpDocumentor.phar --directory src/ --target docs/api
|
||||
|
||||
- name: Deploy to GithHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/api
|
13
.travis.yml
13
.travis.yml
|
@ -36,16 +36,3 @@ jobs:
|
|||
after_script:
|
||||
- wget https://scrutinizer-ci.com/ocular.phar
|
||||
- php ocular.phar code-coverage:upload --format=php-clover tests/coverage-clover.xml
|
||||
|
||||
- stage: API documentations
|
||||
if: tag is present
|
||||
php: 7.4
|
||||
before_script:
|
||||
- curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
|
||||
script:
|
||||
- php phpDocumentor.phar --directory src/ --target docs/api
|
||||
deploy:
|
||||
provider: pages
|
||||
skip-cleanup: true
|
||||
local-dir: docs/api
|
||||
github-token: $GITHUB_TOKEN
|
||||
|
|
Loading…
Reference in New Issue