ci.yml

on:
  push:
    branches:
      - master

name: CI
permissions: read-all

jobs:
  test:
    env:
      GITHUB_API: ${{ secrets.PAT }}
    ## We want to define a strategy for our job
    strategy:
      ## this will contain a matrix of all the combinations
      ## we wish to test again:
      matrix:
        go-version: [ 1.21.x ]
        platform: [ ubuntu-latest, macos-latest, windows-latest ]

    ## Defines the platform for each test run
    runs-on: ${{ matrix.platform }}

    ## the steps that will be run through for each version and platform
    ## combination
    steps:
      ## sets up go based on the version
      - name: Install Go
        uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
        with:
          go-version: ${{ matrix.go-version }}

      ## checks out our code locally, so we can work with the files
      - name: Checkout code
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

      ## runs go test ./...
      - name: Build
        run: go build ./...

      ## runs go test ./...
      - name: Test
        run: go test ./... -coverprofile=./cover.out

      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@3444e47d45411c1e34e39245eb914e9d557d2305 # v3.1.4
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}