build-test.yml

name: 'build-test'

on:
  push:
  pull_request:
  schedule:
    - cron: '0 1 * * *'
  workflow_dispatch:

jobs:
  build_and_unit_test:
    name: '${{ matrix.os }}: build and unit tests'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]

    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
      with:
        egress-policy: audit

    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      with:
        submodules: true
    - uses: lukka/get-cmake@5979409e62bdf841487c5fb3c053149de97a86d3 # latest
    - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
      with:
        node-version: '20.x'
      # How to consume GitHub packages, from this message (!): https://github.community/t/download-from-github-package-registry-without-authentication/14407/35
      # Inspired from here: https://github.com/jcansdale-test/npmrc-configurations/blob/master/.github/workflows/blank.yml
    - name: Authenticate to GitHub Packages
      run: |
        echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
        echo "@${{ github.repository_owner }}:registry=https://npm.pkg.github.com/" >> ~/.npmrc
    - run: npm install
    - run: npm run pre-build
    - run: npm run lint
    - run: npm run test
    - run: npm run build
    - name: Coveralls
      uses: coverallsapp/github-action@cfd0633edbd2411b532b808ba7a8b5e04f76d2c8 # v2.3.4
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        parallel: true
        flag-name: ${{ matrix.os }}-build_and_unit_test
        base-path: ${{ runner.os != 'macOS' && '__tests__/theAssets/vcpkg_project/' || '' }}
        debug: true

  tests:
    name: '${{ matrix.os }}: functional tests'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
      with:
        egress-policy: audit

    - name: checkout this action
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      with:
        submodules: true

    - uses: lukka/get-cmake@5979409e62bdf841487c5fb3c053149de97a86d3 # latest

    - name: basic test for run-vcpkg (not running vcpkg).
      uses: ./
      with:
        vcpkgDirectory: ${{ github.workspace }}/vcpkg
        vcpkgGitCommitId: '8eb57355a4ffb410a2e94c07b4dca2dffbee8e50'
        vcpkgGitUrl: 'https://github.com/microsoft/vcpkg.git'

    - name: basic test for run-vcpkg with running 'vcpkg install'.
      uses: ./
      with:
        vcpkgDirectory: ${{ github.workspace }}/vcpkg
        vcpkgGitCommitId: '8eb57355a4ffb410a2e94c07b4dca2dffbee8e50'
        runVcpkgInstall: true
        vcpkgGitUrl: 'https://github.com/microsoft/vcpkg.git'
      env:
        VCPKG_INSTALLED_DIR: ${{ github.workspace }}/vcpkg_installed

    - name: basic test for run-vcpkg with 'vcpkg-configuration.json'.
      uses: ./
      with:
        vcpkgDirectory: ${{ github.workspace }}/vcpkg
        #vcpkgGitCommitId: is not provided intentionally, the Git commit it is read from vcpkg-configuration.json.
        vcpkgConfigurationJsonGlob: '**/__tests__/theAssets/vcpkg_project/vcpkg-configuration.json'

  tests_with_cache_hit:
    needs: tests
    name: '${{ matrix.os }}: functional tests'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
      with:
        egress-policy: audit

    - name: checkout this action
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      with:
        submodules: true

    - uses: lukka/get-cmake@5979409e62bdf841487c5fb3c053149de97a86d3 # latest

    - name: basic test for run-vcpkg (not running vcpkg).
      uses: ./
      with:
        vcpkgDirectory: ${{ github.workspace }}/vcpkg
        vcpkgGitCommitId: '8eb57355a4ffb410a2e94c07b4dca2dffbee8e50'
        vcpkgGitUrl: 'https://github.com/microsoft/vcpkg.git'

  finalize_coveralls:
    needs: build_and_unit_test
    runs-on: ubuntu-latest
    if: ${{ always() }}
    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
      with:
        egress-policy: audit

    - name: Finalize Coveralls
      uses: coverallsapp/github-action@cfd0633edbd2411b532b808ba7a8b5e04f76d2c8 # v2.3.4
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        parallel-finished: true
        carryforward: "macos-latest-build_and_unit_test,ubuntu-latest-build_and_unit_test,windows-latest-build_and_unit_test"
        debug: true