diff --git a/.github/workflows/generate-openapi-client.yml b/.github/workflows/generate-openapi-client.yml new file mode 100644 index 0000000..853315e --- /dev/null +++ b/.github/workflows/generate-openapi-client.yml @@ -0,0 +1,44 @@ +name: Generate OpenAPI JavaScript client + +on: + push: + paths: + - 'openapi.yaml' + - '.github/workflows/generate-openapi-client.yml' + workflow_dispatch: {} + +jobs: + generate: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Java (required by OpenAPI Generator) + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: '17' + + - name: Generate JavaScript client from OpenAPI + uses: openapitools/openapi-generator-cli@v2.5.0 + with: + arguments: generate -i openapi.yaml -g javascript -o openapi-client-ts --additional-properties=useES6=true,projectName=brencher-openapi + + - name: Generate Python FastAPI server from OpenAPI + uses: openapitools/openapi-generator-cli@v2.5.0 + with: + arguments: generate -i openapi.yaml -g python-fastapi -o openapi-server-py --additional-properties=projectName=brencher-python-server,packageName=brencher_server + +# docker run --rm -v "$PWD":/local openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g python-fastapi -o /local/openapi-server-py --additional-properties=projectName=brencher-python-server,packageName=brencher_server +# docker run --rm -v "$PWD":/local openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g javascript -o /local/openapi-client-ts --additional-properties=useES6=true,projectName=brencher-openapi + + # - name: Commit generated client + # uses: EndBug/add-and-commit@v9 + # with: + # author_name: github-actions + # author_email: actions@github.com + # message: "chore: regenerate OpenAPI JavaScript client" + # add: openapi-client-ts openapi-server-py + # env: + # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/verify-openapi-types.yml b/.github/workflows/verify-openapi-types.yml new file mode 100644 index 0000000..d2e7c36 --- /dev/null +++ b/.github/workflows/verify-openapi-types.yml @@ -0,0 +1,34 @@ +name: Verify OpenAPI types + +on: + pull_request: + push: + branches: [ main ] + +jobs: + verify-openapi-types: + name: Verify generated TypeScript matches committed types + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: '18' + + - name: Generate types from OpenAPI + run: | + set -euo pipefail + npx --yes openapi-typescript openapi.yaml --output generated-openapi-types.ts + + - name: Show diff and fail if different + run: | + set -euo pipefail + if ! command -v diff >/dev/null 2>&1; then echo "diff not found" && exit 2; fi + echo "Comparing generated types to frontend/src/types/api.ts" + if ! diff -u frontend/src/types/api.ts generated-openapi-types.ts; then + echo "OpenAPI types are out of date. Regenerate with: npx openapi-typescript openapi.yaml --output frontend/src/types/api.ts"; + exit 1; + fi