Description
The Quickstart guide lists the following as prerequisites:
- Docker and Docker Compose (Docker Desktop)
- A text editor
However, the database migration step requires Go to be installed, as it uses:
go install github.com/pressly/goose/v3/cmd/goose@v3.26.0
goose -dir migrations postgres "$DATABASE_URL" up
A user following the quickstart with only Docker installed will hit a failure at the migration step since go install requires a local Go toolchain.
Expected behavior
Either:
- Go should be listed as a prerequisite in the quickstart guide, or
- An alternative installation method for
goose that doesn't require Go should be documented (e.g., brew install goose, downloading a pre-built binary, or running migrations inside a Docker container).
Steps to reproduce
- Follow the quickstart guide on a machine with Docker but without Go installed
- Reach the migration step
- Run
go install github.com/pressly/goose/v3/cmd/goose@v3.26.0
- Observe:
command not found: go
Context
Found during QA of the quickstart documentation.
Description
The Quickstart guide lists the following as prerequisites:
However, the database migration step requires Go to be installed, as it uses:
A user following the quickstart with only Docker installed will hit a failure at the migration step since
go installrequires a local Go toolchain.Expected behavior
Either:
goosethat doesn't require Go should be documented (e.g.,brew install goose, downloading a pre-built binary, or running migrations inside a Docker container).Steps to reproduce
go install github.com/pressly/goose/v3/cmd/goose@v3.26.0command not found: goContext
Found during QA of the quickstart documentation.