ci.yml

name: CI

on:
  schedule:
    - cron: '0 10 * * *' # everyday at 10am
  push:
    branches:
      - main
    tags:
      - '*.*.*'
  pull_request:

env:
  node_version: 12.x
  # github.event.repository.clone_url not available for on: schedule
  clone_url: https://github.com/nlpsandbox/nlpsandbox-schemas.git
  # github.event.repository.default_branch not available for on: schedule
  default_branch: main

jobs:
  configure:
    runs-on: ubuntu-latest
    steps:
    - name: Create configuration
      run: |
        # gh-openapi-docs uses the branch name "undefined" when it does not find
        # the name of the current branch
        BRANCH=undefined
        VERSION=noop
        PUSH=false
        if [ "${{ github.event_name }}" = "schedule" ]; then
          BRANCH=${{ env.default_branch }}
          VERSION=nightly
          PUSH=true
        elif [[ $GITHUB_REF == refs/tags/* ]]; then
          VERSION=${GITHUB_REF#refs/tags/}
        elif [[ $GITHUB_REF == refs/heads/* ]]; then
          BRANCH=${GITHUB_REF#refs/heads/}
          VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
          if [ "${{ env.default_branch }}" = "$VERSION" ]; then
            VERSION=edge
            PUSH=true
          fi
        elif [[ $GITHUB_REF == refs/pull/* ]]; then
          VERSION=pr-${{ github.event.number }}
          PUSH=true
        fi
        if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
          MINOR=${VERSION%.*}
          MAJOR=${MINOR%.*}
          PUSH=true
        fi
        printf "%s\n" \
          "branch=${BRANCH}" \
          "version=${VERSION}" \
          "version_major=${MAJOR}" \
          "version_minor=${MINOR}" \
          "created=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" \
          "push=${PUSH}" | tee -a .GITHUB_ENV

    - name: Upload .GITHUB_ENV
      uses: actions/upload-artifact@v2
      with:
        name: GITHUB_ENV
        path: .GITHUB_ENV

  lint:
    needs: [configure]
    runs-on: ubuntu-latest
    strategy:
      matrix:
        api:
        - "contact-annotator"
        - "covid-symptom-annotator"
        - "data-node"
        - "date-annotator"
        - "id-annotator"
        - "location-annotator"
        - "person-name-annotator"
        - "phi-annotator"
        - "phi-deidentifier"
    steps:
    - uses: actions/checkout@v2

    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@v2.2.0
      with:
        node-version: ${{ env.node_version }}

    - name: Install dependencies
      run: npm ci

    - name: Lint openapi specifications
      run: |
        npm run lint --api=${{ matrix.api }}
        npm run validate --api=${{ matrix.api }}

  build:
    needs: [lint]
    runs-on: ubuntu-latest
    strategy:
      matrix:
        api:
        - "contact-annotator"
        - "covid-symptom-annotator"
        - "data-node"
        - "date-annotator"
        - "id-annotator"
        - "location-annotator"
        - "person-name-annotator"
        - "phi-annotator"
        - "phi-deidentifier"
    steps:
    - uses: actions/checkout@v2

    - name: Download .GITHUB_ENV
      uses: actions/download-artifact@v2
      with:
        name: GITHUB_ENV
        path: .

    - name: Restore $GITHUB_ENV
      run: cat .GITHUB_ENV >> $GITHUB_ENV

    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@v2.2.0
      with:
        node-version: ${{ env.node_version }}

    - name: Install dependencies
      run: npm ci

    - name: Create .spec-docs.json
      run: |
        printf "%s\n" \
        '{' \
        '"apiSpecPath": "openapi/${{ matrix.api }}/openapi.yaml",' \
        '"docsRoot": "docs",' \
        '"defaultBranch": "",' \
        '"branchPathBase": "preview"' \
        '}' | tee -a .spec-docs.json >/dev/null

    - name: Create openapi docs
      run: npx gh-openapi-docs-ts

    - name: Prepare for archiving openapi docs
      run: |
        # Add specific version
        TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/${{ env.version }}
        mkdir -p ${TARGET_DIR}
        cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

        # Add latest, major, and minor versions
        if [ ! -z "${{ env.version_major }}" ]; then
          # Update latest version
          TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/latest
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

          # Update major version (e.g. "1.2.3" => "1")
          TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/${{ env.version_major }}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

          # Update minor version (e.g. "1.2.3" => "1.2")
          TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/${{ env.version_minor }}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}
        fi

        # Add edge-<sha>
        if [ "${{ env.version }}" == "edge" ]; then
          TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/edge-${GITHUB_SHA::8}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}
        fi

    - name: Archive openapi docs
      uses: actions/upload-artifact@v2
      with:
        name: gh-openapi-docs
        path: gh-openapi-docs

    - name: Add openapi.yaml to openapi-merge individuals
      run: |
        TARGET_DIR=openapi-individuals/openapi/_internal/individuals
        mkdir -p ${TARGET_DIR}
        cp gh-openapi-docs/${{ matrix.api }}/${{ env.version }}/openapi.yaml \
          ${TARGET_DIR}/${{ matrix.api }}.openapi.yaml

    - name: Archive openapi.yaml for openapi-merge
      uses: actions/upload-artifact@v2
      with:
        name: openapi-individuals
        path: openapi-individuals

  build-aggregates:
    needs: [build]
    runs-on: ubuntu-latest
    strategy:
      matrix:
        api:
        - "tool"
        - "nlpsandbox"
    steps:
    - uses: actions/checkout@v2

    - name: Download .GITHUB_ENV
      uses: actions/download-artifact@v2
      with:
        name: GITHUB_ENV
        path: .

    - name: Restore $GITHUB_ENV
      run: cat .GITHUB_ENV >> $GITHUB_ENV

    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@v2.2.0
      with:
        node-version: ${{ env.node_version }}

    - name: Install dependencies
      run: npm ci

    - name: Download openapi-merge individual openapis
      uses: actions/download-artifact@v2
      with:
        name: openapi-individuals
        path: .

    - name: Build base openapi
      run: npm run build:internal:base --api=${{ matrix.api }}

    - name: Merge individual openapis
      run: npm run merge:internal --api=${{ matrix.api }}

    - name: Validate merged openapi
      run: npm run validate:internal --api=${{ matrix.api }}

    - name: Create .spec-docs.json
      run: |
        printf "%s\n" \
        '{' \
        '"apiSpecPath": "openapi/_internal/${{ matrix.api }}/openapi.yaml",' \
        '"docsRoot": "docs",' \
        '"defaultBranch": "",' \
        '"branchPathBase": "preview"' \
        '}' | tee -a .spec-docs.json >/dev/null
        cat .spec-docs.json

    - name: Create openapi docs
      run: npx gh-openapi-docs-ts

    - name: Prepare for archiving openapi docs
      run: |
        # Add specific version
        TARGET_DIR=gh-openapi-docs/_internal/${{ matrix.api }}/${{ env.version }}
        mkdir -p ${TARGET_DIR}
        cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

        # Add latest, major, and minor versions
        if [ ! -z "${{ env.version_major }}" ]; then
          # Update latest version
          TARGET_DIR=gh-openapi-docs/_internal/${{ matrix.api }}/latest
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

          # Update major version (e.g. "1.2.3" => "1")
          TARGET_DIR=gh-openapi-docs/_internal/${{ matrix.api }}/${{ env.version_major }}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}

          # Update minor version (e.g. "1.2.3" => "1.2")
          TARGET_DIR=gh-openapi-docs/_internal/${{ matrix.api }}/${{ env.version_minor }}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}
        fi

        # Add edge-<sha>
        if [ "${{ env.version }}" == "edge" ]; then
          TARGET_DIR=gh-openapi-docs/${{ matrix.api }}/edge-${GITHUB_SHA::8}
          mkdir -p ${TARGET_DIR}
          cp -R preview/${{ env.branch }}/* ${TARGET_DIR}
        fi

    - name: Archive openapi docs
      uses: actions/upload-artifact@v2
      with:
        name: gh-openapi-docs
        path: gh-openapi-docs

  publish:
    needs: [build-aggregates]
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Download .GITHUB_ENV
      uses: actions/download-artifact@v2
      with:
        name: GITHUB_ENV
        path: .

    - name: Restore $GITHUB_ENV
      run: cat .GITHUB_ENV >> $GITHUB_ENV

    - name: Download gh-openapi-docs artifacts
      uses: actions/download-artifact@v2
      with:
        name: gh-openapi-docs
        path: gh-openapi-docs

    - name: Commit doc changes
      run: |
        git clone ${{ env.clone_url }} \
          --branch gh-pages --single-branch gh-pages

        cp -R gh-openapi-docs/* gh-pages/.

        cd gh-pages
        git config --local user.email "action@github.com"
        git config --local user.name "GitHub Action"
        git add .
        git commit -m "Update documentation" -a || true
        # The above command will fail if no changes were present, so we ignore
        # that.

    - name: Push changes
      if: env.push == 'true'
      uses: ad-m/github-push-action@master
      with:
        branch: gh-pages
        directory: gh-pages
        github_token: ${{ secrets.GITHUB_TOKEN }}
        force: true