Skip to content

Implemented workflow to automate api documentation #1

Implemented workflow to automate api documentation

Implemented workflow to automate api documentation #1

Workflow file for this run

name: Generate API documentation

Check failure on line 1 in .github/workflows/update-api-docs.yml

View workflow run for this annotation

GitHub Actions / .github/workflows/update-api-docs.yml

Invalid workflow file

`push_request` is not a valid event name
on:
push_request:
branches:
- develop
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Build Docker image
run: docker compose -f docker-compose.yml -f docker-compose.dev.yml up dev-service
- name: Generate API documentation
uses: addnab/docker-run-action@v3
with:
image: mathesar/mathesar-dev:latest
run: ./manage.py spectacular --color --file schema.yml
- name: Check if schema file has changed
run: git diff --quiet schema.yml || exit 0
- name: Commit schema file
run: git add schema.yml && git commit -m "Add schema file"
- name: Push changes to remote branch
run: git push origin ${{ github.head_ref }}