Merge pull request #18 from EscolaLMS/feature/WELLMS-334 #22
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
name: Generate Contracts Documentation | |
on: | |
push: | |
branches: | |
- main | |
- master | |
jobs: | |
phpunit-code-coverage: | |
runs-on: ubuntu-latest | |
container: | |
image: escolalms/php:8.2 | |
steps: | |
- name: Instantiate package | |
uses: actions/checkout@v2 | |
- name: Setup environment | |
run: cp -r env/codecov/. . | |
- name: add Contracts main annotaion | |
run: php -r "file_put_contents('src/EscolaLmsConsultationAccessServiceProvider.php', str_replace('SWAGGER_VERSION', '@OA\Info(title=\"EscolaLMS\", version=\"0.0.1\")', file_get_contents('src/EscolaLmsConsultationAccessServiceProvider.php')));" | |
- name: Update composer | |
run: composer update | |
- name: Require composer swagger package | |
run: composer require darkaonline/l5-swagger | |
- name: Discover packages | |
run: vendor/bin/testbench package:discover --ansi | |
- name: Generate YAML openapi | |
run: vendor/bin/openapi --format json -b env/openapi/config.php -o openapi.json src | |
- name: Generate Swagger UI | |
uses: Legion2/swagger-ui-action@v1 | |
with: | |
output: swagger-ui | |
spec-file: openapi.json | |
- name: Install git | |
run: apt-get install git -y | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: swagger-ui |