code-check.yml

# This GitHub action runs your tests for each commit push and/or PR. Optionally
# you can turn it on using a cron schedule for regular testing.
#
name: Provider Code Check
on:
  pull_request:
    paths-ignore:
      - 'README.md'
      - '.vscode'
      - '.gitignore'
      - 'CHANGELOG.md'
      - 'CONTRIBUTING.md'
      - 'LICENSE'
  push:
    branches: [ "main" ]
    paths-ignore:
      - 'README.md'
      - '.vscode'
      - '.gitignore'
      - 'CHANGELOG.md'
      - 'CONTRIBUTING.md'
      - 'LICENSE'
  # For systems with an upstream API that could drift unexpectedly (like most SaaS systems, etc.),
  # we recommend testing at a regular interval not necessarily tied to code changes. This will 
  # ensure you are alerted to something breaking due to an API change, even if the code did not
  # change.
  # schedule:
  #   - cron: '0 13 * * *'
jobs:
  # ensure the code builds...
  build:
    name: Build
    runs-on: ubuntu-latest
    timeout-minutes: 5
    steps:

    - name: Check out code into the Go module directory
      uses: actions/checkout@v4

    - name: Set up Go
      uses: actions/setup-go@v5
      with:
        go-version-file: 'go.mod'
      id: go

    - name: Get dependencies
      run: |
        go mod download

    - name: Check dependencies
      run: |
        make depscheck

    - name: Vet
      run: |
        make vet

    - name: Build
      run: |
        make build

  generate:
    name: go generate
    needs: [build]
    runs-on: ubuntu-latest
    env:
      PINGONE_USERNAME: ${{ secrets.NA_PINGONE_USERNAME }}
      PINGONE_PASSWORD: ${{ secrets.NA_PINGONE_PASSWORD }}
      PINGONE_ENVIRONMENT_ID: ${{ secrets.NA_PINGONE_ENVIRONMENT_ID }}
      PINGONE_REGION: "NorthAmerica"
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'
      
      - run: cd tools && go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
      - run: cd tools && go install github.com/katbyte/terrafmt
      - run: cd tools && go install github.com/samir-gandhi/dvgenerate/cmd/generate
      - run: make generate

      - name: git diff
        run: |
          git diff --compact-summary --exit-code -- docs/ examples/ internal/ || \
            (echo; echo "Unexpected difference in directories after code generation. Run 'make generate' command and commit."; exit 1)

  terrafmtcheck:
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'

      - run: cd tools && go install github.com/katbyte/terrafmt
      - name: terrafmtcheck lint
        run: |
          make terrafmtcheck
          
  golangci-lint:
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'

      - id: golangci-lint-version
        working-directory: tools
        run: >-
          echo "version=$(
            go list -m all |
            grep github.com/golangci/golangci-lint |
            awk '{print $2}'
          )" >> $GITHUB_OUTPUT

      - name: lint
        uses: golangci/golangci-lint-action@v6
        with:
          version: "${{ steps.golangci-lint-version.outputs.version }}"

  importlint:
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'

      - run: cd tools && go install github.com/pavius/impi/cmd/impi

      - name: Check dependencies
        run: make depscheck

      - name: import lint
        run: |
          make importlint

  providerlint:
    name: provider lint
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'

      - run: cd tools && go install github.com/bflad/tfproviderlint/cmd/tfproviderlintx

      - name: Check dependencies
        run: make depscheck

      - name: provider lint
        run: |
          make providerlint

  tflint:
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: 'go.mod'

      - run: cd tools && go install github.com/terraform-linters/tflint

      - name: Check dependencies
        run: make depscheck

      - name: tf lint
        run: |
          make tflint