api.yml

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: API

on:
  push:
    branches-ignore:
    - deepsource-fix-**
    - renovate/**
    - weblate
  pull_request:

permissions:
  contents: read

jobs:
  api-lint:
    runs-on: ubuntu-24.04
    continue-on-error: ${{ matrix.experimental }}
    name: API Lint
    env:
      CI_DATABASE: postgresql
      CI_REDIS_HOST: 127.0.0.1
      CI_REDIS_PORT: '60001'
      CI_DB_PASSWORD: weblate
      CI_DB_HOST: 127.0.0.1
      CI_DB_PORT: '60000'
      CI_SELENIUM: '1'
      DJANGO_SETTINGS_MODULE: weblate.settings_test
      PYTHONWARNINGS: default,ignore:unclosed:ResourceWarning
      PYTHONUNBUFFERED: 1
    steps:
    - uses: actions/checkout@v4
    - uses: astral-sh/setup-uv@v3
      with:
        enable-cache: true
        cache-dependency-glob: ''
        cache-suffix: ${{ matrix.python-version }}
    - name: Start services
      run: ./ci/services-up $CI_DATABASE
    - name: Install apt dependencies
      run: sudo ./ci/apt-install $CI_DATABASE
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: 3.12
    - name: Used versions
      run: ./ci/print-versions
    - name: Install Python dependencies
      run: ./ci/pip-install latest
    - name: Generate OpenAPI
      run: ./manage.py spectacular > weblate-openapi.yaml
    - name: openapi-lint
      uses: mhiew/redoc-lint-github-action@v4
      with:
        args: weblate-openapi.yaml