Merge remote-tracking branch 'upstream/main'

Author: asmyasnikov

.github/workflows/ci.yaml

@@ -3,30 +3,32 @@ name: Goose CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   test:
     name: Run unit tests
     timeout-minutes: 10
 
-    concurrency:
-      group: test-${{ github.ref }}-${{ matrix.os }}-${{ matrix.go-version }}
-      cancel-in-progress: true
     strategy:
       fail-fast: false
       matrix:
-        go-version: ["1.20", "1.21", "1.22"]
+        go-version: [oldstable, stable]
         os: [ubuntu-latest]
 
     runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install Go
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ matrix.go-version }}
       - name: Check Go code formatting
@@ -36,18 +38,23 @@ jobs:
             echo "Please format Go code by running: go fmt ./..."
             exit 1
           fi
+      - name: Install tparse
+        run: go install github.com/mfridman/tparse@main
       - name: Run tests
         run: |
+          make add-gowork
           mkdir -p bin
           go vet ./...
           go build ./...
           make test-packages
       - name: Install GoReleaser
-        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.go-version == '1.22'
-        uses: goreleaser/goreleaser-action@v5
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main' && matrix.go-version == 'stable'
+        uses: goreleaser/goreleaser-action@v6
         with:
           install-only: true
+          distribution: goreleaser
+          version: "~> v2"
       - name: Gorelease dry-run
-        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.go-version == '1.22'
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main' && matrix.go-version == 'stable'
         run: |
           goreleaser release --skip=publish --snapshot --fail-fast --clean

.github/workflows/integration.yaml

@@ -3,8 +3,9 @@ name: Goose integration tests
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
+  workflow_dispatch:
 
 concurrency: 
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -18,11 +19,13 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install Go
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: "stable"
+      - name: Install tparse
+        run: go install github.com/mfridman/tparse@main
       - name: Run full integration tests
         run: |
           make test-integration

.github/workflows/lint.yaml

@@ -3,9 +3,9 @@ name: golangci
 on:
   push:
     branches:
-      - master
       - main
   pull_request:
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -17,12 +17,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
+        uses: actions/checkout@v5
+      - uses: actions/setup-go@v6
         with:
           go-version: "stable"
+      - run: make add-gowork
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
           version: latest

.github/workflows/release.yaml

@@ -9,21 +9,22 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - run: git fetch --force --tags
-      - uses: actions/setup-go@v5
+      - uses: actions/setup-go@v6
         with:
           go-version: stable
       - name: Generate release notes
         continue-on-error: true
         run: ./scripts/release-notes.sh ${{github.ref_name}} > ${{runner.temp}}/release_notes.txt
+      - run: make add-gowork
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
-          version: latest
+          version: "~> v2"
           args: release --clean --release-notes=${{runner.temp}}/release_notes.txt
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -7,6 +7,10 @@
 # Files output by tests
 /bin
 
+# Coverage files
+coverage.out
+coverage.html
+
 # Local testing
 .envrc
 *.FAIL

.golangci.yaml

@@ -0,0 +1,31 @@
+version: "2"
+linters:
+  default: none
+  enable:
+    - errcheck
+    - govet
+    - ineffassign
+    - misspell
+    - staticcheck
+    - testifylint
+    - unused
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofmt
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.goreleaser.yaml

@@ -1,6 +1,7 @@
 # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
 #
 # See https://goreleaser.com/customization/ for more information.
+version: 2
 project_name: goose
 
 before:
@@ -24,12 +25,13 @@ builds:
       - "-s -w -X main.version=v{{ .Version }}"
 
 archives:
-  - format: binary
+  - formats:
+      - binary
     name_template: >-
       {{ .ProjectName }}_{{- tolower .Os }}_{{- if eq .Arch "amd64" }}x86_64{{- else }}{{ .Arch }}{{ end }}
 checksum:
   name_template: "checksums.txt"
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
   use: github-native

CHANGELOG.md

@@ -5,7 +5,127 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## Unreleased
+
+- Support [environ credentials](https://github.com/ydb-platform/ydb-go-sdk-auth-environ/?tab=readme-ov-file#auth-environment-variables)
+  for YDB using parameter `use_env_credentials` in connection string.
+  Example:
+  ```bash
+  export YDB_ACCESS_TOKEN_CREDENTIALS="my-secret-token"
+  goose ydb "grpcs://localhost:2135/local?go_query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric&use_env_credentials" status
+  ```
+- Add preliminary Spanner dialect support (#966)
+- Remove `StatementBegin` and `StatementEnd` annotations from SQL migration templates
+  - This is only required for more complex statements that include semicolons within them, such as
+    stored procedures or functions. For simple statements, these annotations are not needed. See
+    [docs](https://pressly.github.io/goose/documentation/annotations/#complex-statements) for more
+    details.
+
+## [v3.26.0] - 2025-10-03
+
+- Add `*slog.Logger` support to goose provider via option `WithSlog` (#989)
+- Add convenience `WithTableName` provider option (#985)
+- Minor bug fixes and dependency upgrades
+- Add general purpose `Locker` interface to support DB locking with a table-based Postgres
+  implementation via `lock.NewPostgresTableLocker` (#993 for more details)
+  - Unlike `SessionLocker`, this uses the `*sql.DB` connection pool
+  - Add `WithLocker` option to goose provider
+
+## [v3.25.0] - 2025-08-24
+
+- Upgrade go deps (#976)
+- Remove references/tests for vertica and add deprecation warnings (#978)
+- Add Aurora DSQL as a new database dialect to goose `Provider` (#971)
+- Add DDL isolation support for Aurora DSQL compatibility (#970)
+- Update Apply to respect no versioning option (#950)
+- Expose dialect `Querier` (#939)
+
+## [v3.24.3]
+
+- Add `GOOSE_TABLE` environment variable -- lower priority than `-table` flag, but higher than the
+  default table name. (#932)
+- Dependency updates
+
+## [v3.24.2]
+
+- Add `TableExists` table existence check for the mysql dialect (#895)
+- Upgrade **minimum Go version to 1.23**
+- Various dependency updates
+
+## [v3.24.1]
+
+- Fix regression (`v3.23.1` and `v3.24.0`) in postgres migration table existence check for
+  non-default schema. (#882, #883, #884).
+
+## [v3.24.0]
+
+- Add support for loading environment variables from `.env` files, enabled by default.
+  - The default file name is `.env`, but can be changed with the `-env=<filename>` flag.
+  - To disable this feature, set `-env=none`.
+
+## [v3.23.1]
+
+- Store implementations can **optionally** implement the `TableExists` method to provide optimized
+  table existence checks (#860)
+  - Default postgres Store implementation updated to use `pg_tables` system catalog, more to follow
+  - Backward compatible change - existing implementations will continue to work without modification
+
+```go
+TableExists(ctx context.Context, db database.DBTxConn) (bool, error)
+```
+
+## [v3.23.0]
+
+- Add `WithLogger` to `NewProvider` to allow custom loggers (#833)
+- Update Provider `WithVerbose` behavior to log all SQL statements (#851)
+- Upgrade dependencies and rebuild binaries with latest Go version (`go1.23.3`)
+
+## [v3.22.1]
+
+- Upgrade dependencies and rebuild binaries with latest Go version (`go1.23.1`)
+
+## [v3.22.0]
+
+- Minimum Go version is now 1.21
+- Add Unwrap to PartialError (#815)
+- Allow flags anywhere on the CLI (#814)
+
+`goose` uses the default Go `flag` parsing library, which means flags **must** be defined before the
+first positional argument. We've updated this behavior to allow flags to be defined anywhere. For
+more details, see [blog post](https://mfridman.com/blog/2024/allowing-flags-anywhere-on-the-cli/).
+
+- Update `WithDisableGlobalRegistry` behavior (#783). When set, this will ignore globally-registered
+  migrationse entirely instead of the previous behavior of raising an error. Specifically, the
+  following check is removed:
+
+```go
+if len(global) > 0 {
+	return nil, errors.New("global registry disabled, but provider has registered go migrations")
+}
+```
+
+This enables creating isolated goose provider(s) in legacy environments where global migrations may
+be registered. Without updating this behavior, it would be impossible to use
+`WithDisableGlobalRegistry` in combination with provider-scoped `WithGoMigrations`.
+
+- Postgres, updated schema to use identity instead of serial and make `tstamp` not nullable (#556)
+
+```diff
+- id serial NOT NULL,
++ id integer PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY,
+
+- tstamp timestamp NULL default now(),
++ tstamp timestamp NOT NULL DEFAULT now()
+```
+
+- MySQL, updated schema to not use SERIAL alias (#816)
+
+```diff
+- id serial NOT NULL,
++ id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+```
+
+## [v3.21.1]
 
 - Add `GetVersions` method to `goose.Provider`, returns the current (max db) version and the latest
   (max filesystem) version. (#756)
@@ -18,13 +138,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   to get the latest version_id irrespective of the order of applied migrations.
   - Refactor existing portions of the code to use the new `GetLatestVersion` method.
 
-- Support [environ credentials](https://github.com/ydb-platform/ydb-go-sdk-auth-environ/?tab=readme-ov-file#auth-environment-variables) 
-  for YDB using parameter `use_env_credentials` in connection string. 
-  Example:
-  ```bash
-  export YDB_ACCESS_TOKEN_CREDENTIALS="my-secret-token"
-  goose ydb "grpcs://localhost:2135/local?go_query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric&use_env_credentials" status
-  ```
+## [v3.21.0]
+
+- Retracted. Broken release, please use v3.21.1 instead.
 
 ## [v3.20.0]
 
@@ -151,7 +267,7 @@ Here's a quick summary:
 
 - Fix `sqlparser` to avoid skipping the last statement when it's not terminated with a semicolon
   within a StatementBegin/End block. (#580)
-- Add `go1.21` to the CI matrix.
+- Add `**go1.21**` to the CI matrix.
 - Bump minimum version of module in go.mod to `go1.19`.
 - Fix version output when installing pre-built binaries (#585).
 
@@ -189,7 +305,19 @@ Here's a quick summary:
 - Add new `context.Context`-aware functions and methods, for both sql and go migrations.
 - Return error when no migration files found or dir is not a directory.
 
-[Unreleased]: https://github.com/pressly/goose/compare/v3.20.0...HEAD
+[Unreleased]: https://github.com/pressly/goose/compare/v3.26.0...HEAD
+[v3.26.0]: https://github.com/pressly/goose/compare/v3.25.0...v3.26.0
+[v3.25.0]: https://github.com/pressly/goose/compare/v3.24.3...v3.25.0
+[v3.24.3]: https://github.com/pressly/goose/compare/v3.24.2...v3.24.3
+[v3.24.2]: https://github.com/pressly/goose/compare/v3.24.1...v3.24.2
+[v3.24.1]: https://github.com/pressly/goose/compare/v3.24.0...v3.24.1
+[v3.24.0]: https://github.com/pressly/goose/compare/v3.23.1...v3.24.0
+[v3.23.1]: https://github.com/pressly/goose/compare/v3.23.0...v3.23.1
+[v3.23.0]: https://github.com/pressly/goose/compare/v3.22.1...v3.23.0
+[v3.22.1]: https://github.com/pressly/goose/compare/v3.22.0...v3.22.1
+[v3.22.0]: https://github.com/pressly/goose/compare/v3.21.1...v3.22.0
+[v3.21.1]: https://github.com/pressly/goose/compare/v3.20.0...v3.21.1
+[v3.21.0]: https://github.com/pressly/goose/compare/v3.20.0...v3.21.0
 [v3.20.0]: https://github.com/pressly/goose/compare/v3.19.2...v3.20.0
 [v3.19.2]: https://github.com/pressly/goose/compare/v3.19.1...v3.19.2
 [v3.19.1]: https://github.com/pressly/goose/compare/v3.19.0...v3.19.1