Skip to content

Quickstart prerequisites missing Go as a requirement for database migration #55

@Dhruwang

Description

@Dhruwang

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

  1. Follow the quickstart guide on a machine with Docker but without Go installed
  2. Reach the migration step
  3. Run go install github.com/pressly/goose/v3/cmd/goose@v3.26.0
  4. Observe: command not found: go

Context

Found during QA of the quickstart documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions