ci.yml

name: CI

on:
  push:
    branches:
    - master
    - release/*
  pull_request:
    branches:
    - master
    - release/*
  workflow_dispatch: {}

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  lint:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
    - uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
      with:
        go-version: stable
    - name: Root module requires no other module
      # The database drivers belong to the dbtest module only; a requirement
      # here would reach every consumer's module graph.
      run: |
        out="$(go list -m all)"
        if [ "$out" != "$(go list -m)" ]; then echo "go.mod requires:"; echo "$out"; exit 1; fi
    - name: go vet
      run: |
        go vet ./...
        (cd dbtest && go vet ./...)
    - name: staticcheck
      # v0.8.1 cannot read Go 1.27.2 export data ("export data version 5 is greater than maximum
      # supported version 4"). This master build from 2026-10-09 can; pin a tagged release again
      # once one is published.
      run: |
        go run honnef.co/go/tools/cmd/staticcheck@v0.7.0-0.dev.0.20261009230814-452d5bb86b45 -checks=all ./...
        (cd dbtest && go run honnef.co/go/tools/cmd/staticcheck@v0.7.0-0.dev.0.20261009230814-452d5bb86b45 -checks=all ./...)
    - name: goimports
      run: |
        out="$(go run golang.org/x/tools/cmd/goimports@v0.52.0 -l -local "$(go list -m)" .)"
        if [ -n "$out" ]; then echo "goimports would change:"; echo "$out"; exit 1; fi
    - name: govulncheck
      run: |
        go run golang.org/x/vuln/cmd/govulncheck@v1.8.0 ./...
        (cd dbtest && go run golang.org/x/vuln/cmd/govulncheck@v1.8.0 ./...)

  test:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    strategy:
      fail-fast: false
      matrix:
        go:
        - "1.24.x"
        - "1.25.x"
        - oldstable
        - stable
    services:
      postgres:
        image: postgres:16
        env:
          POSTGRES_PASSWORD: sqlx
        ports:
        - 5432:5432
        options: >-
          --health-cmd "pg_isready -U postgres"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 20
      mysql:
        image: mysql:8
        env:
          MYSQL_ROOT_PASSWORD: sqlx
          MYSQL_DATABASE: sqlx
        ports:
        - 3306:3306
        options: >-
          --health-cmd "mysqladmin ping -h 127.0.0.1 -psqlx"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 30
    env:
      CGO_ENABLED: "1"
      SQLX_POSTGRES_DSN: postgres://postgres:sqlx@localhost:5432/postgres?sslmode=disable
      SQLX_MYSQL_DSN: root:sqlx@tcp(127.0.0.1:3306)/sqlx
    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
    - uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
      with:
        go-version: ${{ matrix.go }}
    - name: Unit tests with the race detector
      run: go test -race -count=1 ./...
    - name: Database tests with the race detector against Postgres, MySQL and SQLite
      working-directory: dbtest
      env:
        SQLX_SQLITE_DSN: ${{ runner.temp }}/sqlx.db
      run: |
        go test -race -count=1 -v ./... 2>&1 | tee ../test.log
        test "${PIPESTATUS[0]}" -eq 0
    - name: Fail if a database was skipped
      # init() prints "Disabling ..." and the schema tests then run zero rounds for that database.
      run: |
        if grep -n "Disabling" test.log; then exit 1; fi

  apidiff:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        fetch-depth: 0
    - uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
      with:
        go-version: stable
    - name: Export the v1.4.0 API under the fork's module path
      # The export is written and read in this same job, with one toolchain,
      # because export data is bound to the Go version that produced it.
      run: |
        git worktree add "${{ runner.temp }}/v1.4.0" v1.4.0
        cd "${{ runner.temp }}/v1.4.0"
        sed -i 's#github.com/jmoiron/sqlx#github.com/secondwindoss/sqlx#g' go.mod $(git ls-files '*.go')
        go run golang.org/x/exp/cmd/apidiff@v0.0.0-20261009195045-ca0d7ba23607 -m -w "${{ runner.temp }}/v1.4.0.export" github.com/secondwindoss/sqlx
    - name: Fail on any incompatible change since v1.4.0
      run: |
        out="$(go run golang.org/x/exp/cmd/apidiff@v0.0.0-20261009195045-ca0d7ba23607 -m -incompatible "${{ runner.temp }}/v1.4.0.export" github.com/secondwindoss/sqlx)"
        if [ -n "$out" ]; then echo "$out"; exit 1; fi
        go run golang.org/x/exp/cmd/apidiff@v0.0.0-20261009195045-ca0d7ba23607 -m "${{ runner.temp }}/v1.4.0.export" github.com/secondwindoss/sqlx

  ci-ok:
    if: always()
    needs:
    - lint
    - test
    - apidiff
    runs-on: ubuntu-latest
    steps:
    - name: Check required jobs
      if: >-
        contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
        || contains(needs.*.result, 'skipped')
      run: exit 1