api-client.yaml

# A lot of this was inspired by https://brunoscheufler.com/blog/2022-04-24-required-github-actions-jobs-in-a-monorepo

name: API-Client

on:
  pull_request:
    paths:
      - 'api-client/**'
      - '.github/workflows/api-client.yaml'
jobs:
  change-detection:
    runs-on: ubuntu-latest
    outputs:
      api-client: ${{ steps.changes.outputs.api-client }}
    steps:
      - uses: dorny/paths-filter@v2
        id: changes
        with:
          list-files: shell
          filters: |
            api-client:
              - 'api-client/**'
  tests:
    needs: change-detection
    if: needs.change-detection.outputs.api-client == 'true'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Install NPM packages
        working-directory: ./api-client
        run: yarn install

      - name: Setting up .environment variables
        working-directory: ./api-client
        run: cp .env.sample .env

      - name: Download a openapi_spec
        uses: dawidd6/action-download-artifact@v2
        with:
          name: openapi_spec_artifact
          workflow: openapi.yaml
          workflow_conclusion: success
          check_artifacts: true
          path: ./docs/generated

      - name: Generating Typescript API
        working-directory: ./api-client
        run: yarn run generate-api

      - name: Lint
        working-directory: ./api-client
        run: yarn run lint
        shell: bash

      - name: Unit tests
        working-directory: ./api-client
        run: yarn run test
        shell: bash

  after-tests:
    needs: tests # run after tests
    runs-on: ubuntu-latest
    if: success() # only run when all test have passed
    # store success output flag for ci job
    outputs:
      success: ${{ steps.setoutput.outputs.success }}
    steps:
      - id: setoutput
        run: echo "::set-output name=success::true"

  dummy-step:
    runs-on: ubuntu-latest
    needs: change-detection
    # runs if API-Client was not changed
    if: needs.change-detection.outputs.api-client == 'false'
    outputs:
      success: ${{ steps.setoutput.outputs.success }}
    steps:
      - id: setoutput
        run: echo "::set-output name=success::true"


  # step that will be used for required status check
  # make sure it has a unique name! this will always run, but
  # after the tests & after-tests steps or the dummy step in case
  # the API was not modified
  ci_api_client:
    runs-on: ubuntu-20.04
    if: always()
    needs: [tests, after-tests, dummy-step]
    steps:
      - run: |
          passed="${{ needs.after-tests.outputs.success || needs.dummy-step.outputs.success }}"
          if [[ $passed == "true" ]]; then
            echo "Tests passed"
            exit 0
          else
            echo "Tests failed"
            exit 1
          fi