api_ci.yml

name: API CI

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  push:
    branches:
    - main
    paths:
    - 'api/**'
  pull_request:
    branches:
    - main
    paths:
    - 'api/**'

jobs:
  api_checks:
    name: API Checks
    runs-on: ubuntu-latest
    # Don't run nightly builds for forks.
    if: github.repository == 'allenai/allennlp-demo' || github.event_name != 'schedule'
    steps:
    - uses: actions/checkout@v2

    - name: Setup Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.8

    - uses: actions/cache@v2
      with:
        path: ${{ env.pythonLocation }}
        key: ${{ runner.os }}-pydeps-${{ env.pythonLocation }}-${{ hashFiles('api/requirements.txt') }}-${{ hashFiles('api/dev-requirements.txt') }}-v2

    - name: Install requirements
      working-directory: api
      env:
        ALLENNLP_VERSION_OVERRIDE: allennlp
      run: |
        pip install -r requirements.txt -r dev-requirements.txt

    - name: Debug info
      run: |
        pip freeze

    - name: Format
      working-directory: api
      if: '! cancelled()'
      run: |
        make format

    - name: Lint
      working-directory: api
      if: '! cancelled()'
      run: |
        make lint

    - name: Type check
      working-directory: api
      if: '! cancelled()'
      run: |
        make typecheck

  endpoint_test:
    name: Endpoint Test
    runs-on: [self-hosted]
    # self-hosted runner only available on main repo
    if: github.repository == 'allenai/allennlp-demo'
    strategy:
      fail-fast: false
      matrix:
        # This should be all of the directory names in api/allennlp_demo that correspond
        # to demo model endpoints.
        model: [
          "atis_parser",
          "bidaf",
          "bidaf_elmo",
          "constituency_parser",
          "coref",
          "dependency_parser",
          "elmo_snli",
          "fine_grained_ner",
          "glove_sentiment_analysis",
          "lerc",
          "masked_lm",
          "named_entity_recognition",
          "naqanet",
          "next_token_lm",
          "nlvr_parser",
          "nmn_drop",
          "open_information_extraction",
          "roberta_mnli",
          "roberta_sentiment_analysis",
          "roberta_snli",
          "binary_gender_bias_mitigated_roberta_snli",
          "adversarial_binary_gender_bias_mitigated_roberta_snli",
          "semantic_role_labeling",
          "transformer_qa",
          "vilbert_vqa",
          "wikitables_parser",
          "tasks",
          "model_cards"
        ]
    steps:
    - uses: actions/checkout@v2
    - name: Build and test endpoint
      working-directory: api
      run: |
        make ${{ matrix.model }}-test DOCKER_TAG=$GITHUB_SHA

  validate_ci:
    name: Validate CI Config
    runs-on: ubuntu-latest
    # Don't run nightly builds for forks.
    if: github.repository == 'allenai/allennlp-demo' || github.event_name != 'schedule'
    steps:
    - uses: actions/checkout@v2

    - name: Setup Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.8

    - name: Install requirements
      run: |
        pip install PyYAML

    - name: Validate GitHub Actions config
      run: |
        # If this step fails, this means the model matrix in the 'endpoint_test' GitHub Actions
        # job needs to be updated.
        python dev/check_models_ci.py