Skip to content

docs(readme): use make instead of make build in build steps#174

Merged
appleboy merged 1 commit intomainfrom
worktree-readme
Apr 23, 2026
Merged

docs(readme): use make instead of make build in build steps#174
appleboy merged 1 commit intomainfrom
worktree-readme

Conversation

@appleboy
Copy link
Copy Markdown
Member

@appleboy appleboy commented Apr 23, 2026

Summary

Test plan

  • On a fresh clone, run go mod download -modfile=go.tools.mod
    go run -modfile=go.tools.mod scripts/build_assets.go --minify
    Built: main-AD2EMZ77.css
    Built: main-57ZPFXAY.js
    Generated: internal/templates/asset_paths.go
    go tool -modfile=go.tools.mod swag init -g main.go --output api --parseDependency --parseInternal
    2026/04/23 18:54:27 Generate swagger docs....
    2026/04/23 18:54:27 Generate general API Info, search dir:./
    2026/04/23 18:54:29 warning: failed to evaluate const mProfCycleWrap at /Users/mtk10671/.gvm/gos/go1.26.2/src/runtime/mprof.go:179:7, reflect: call of reflect.Value.Len on zero Value
    2026/04/23 18:54:29 Generating handlers.JWKSResponse
    2026/04/23 18:54:29 Generating handlers.JSONWebKey
    2026/04/23 18:54:29 Generating handlers.discoveryMetadata
    2026/04/23 18:54:29 Generating handlers.clientRegistrationRequest
    2026/04/23 18:54:29 create docs.go at api/docs.go
    2026/04/23 18:54:29 create swagger.json at api/swagger.json
    2026/04/23 18:54:29 create swagger.yaml at api/swagger.yaml
    go generate ./...
    go build -v -tags '' -ldflags '-s -w -X 'github.com/go-authgate/authgate/internal/version.Version=v0.25.0-15-g2234db1' -X 'github.com/go-authgate/authgate/internal/version.BuildTime=2026-04-23T18:54:30' -X 'github.com/go-authgate/authgate/internal/version.GitCommit=2234db1ceb3d7fb4a8a0fab3c6b19fc90620dd46' -X 'github.com/go-authgate/authgate/internal/version.GoVersion=go1.26.2' -X 'github.com/go-authgate/authgate/internal/version.BuildOS=darwin' -X 'github.com/go-authgate/authgate/internal/version.BuildArch=arm64'' -o bin/authgate . — binary builds at Usage: bin/authgate [OPTIONS] COMMAND

OAuth 2.0 Device Authorization Grant server

Commands:
server Start the OAuth server

Options:
-v, --version Show version information
-h, --help Show this help message with no templ errors

  • AuthGate version v0.25.0-15-g2234db1
    Git commit: 2234db1
    Build time: 2026-04-23T18:54:30
    Go version: go1.26.2
    Built for: darwin/arm64 prints version info
  • 603:make build_linux_amd64
    604:make build_linux_arm64 only matches go mod download -modfile=go.tools.mod
    go run -modfile=go.tools.mod scripts/build_assets.go --minify
    Built: main-AD2EMZ77.css
    Built: main-57ZPFXAY.js
    Generated: internal/templates/asset_paths.go
    go tool -modfile=go.tools.mod swag init -g main.go --output api --parseDependency --parseInternal
    2026/04/23 18:54:39 Generate swagger docs....
    2026/04/23 18:54:39 Generate general API Info, search dir:./
    2026/04/23 18:54:41 warning: failed to evaluate const mProfCycleWrap at /Users/mtk10671/.gvm/gos/go1.26.2/src/runtime/mprof.go:179:7, reflect: call of reflect.Value.Len on zero Value
    2026/04/23 18:54:41 Generating handlers.JWKSResponse
    2026/04/23 18:54:41 Generating handlers.JSONWebKey
    2026/04/23 18:54:41 Generating handlers.discoveryMetadata
    2026/04/23 18:54:41 Generating handlers.clientRegistrationRequest
    2026/04/23 18:54:41 create docs.go at api/docs.go
    2026/04/23 18:54:41 create swagger.json at api/swagger.json
    2026/04/23 18:54:41 create swagger.yaml at api/swagger.yaml
    go generate ./...
    CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags '' -ldflags '-s -w -X 'github.com/go-authgate/authgate/internal/version.Version=v0.25.0-15-g2234db1' -X 'github.com/go-authgate/authgate/internal/version.BuildTime=2026-04-23T18:54:43' -X 'github.com/go-authgate/authgate/internal/version.GitCommit=2234db1ceb3d7fb4a8a0fab3c6b19fc90620dd46' -X 'github.com/go-authgate/authgate/internal/version.GoVersion=go1.26.2' -X 'github.com/go-authgate/authgate/internal/version.BuildOS=darwin' -X 'github.com/go-authgate/authgate/internal/version.BuildArch=arm64'' -o release/linux/amd64/authgate . / go mod download -modfile=go.tools.mod
    go run -modfile=go.tools.mod scripts/build_assets.go --minify
    Built: main-AD2EMZ77.css
    Built: main-57ZPFXAY.js
    Generated: internal/templates/asset_paths.go
    go tool -modfile=go.tools.mod swag init -g main.go --output api --parseDependency --parseInternal
    2026/04/23 18:55:05 Generate swagger docs....
    2026/04/23 18:55:05 Generate general API Info, search dir:./
    2026/04/23 18:55:07 warning: failed to evaluate const mProfCycleWrap at /Users/mtk10671/.gvm/gos/go1.26.2/src/runtime/mprof.go:179:7, reflect: call of reflect.Value.Len on zero Value
    2026/04/23 18:55:07 Generating handlers.JWKSResponse
    2026/04/23 18:55:07 Generating handlers.JSONWebKey
    2026/04/23 18:55:07 Generating handlers.discoveryMetadata
    2026/04/23 18:55:07 Generating handlers.clientRegistrationRequest
    2026/04/23 18:55:07 create docs.go at api/docs.go
    2026/04/23 18:55:07 create swagger.json at api/swagger.json
    2026/04/23 18:55:07 create swagger.yaml at api/swagger.yaml
    go generate ./...
    CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -a -tags '' -ldflags '-s -w -X 'github.com/go-authgate/authgate/internal/version.Version=v0.25.0-15-g2234db1' -X 'github.com/go-authgate/authgate/internal/version.BuildTime=2026-04-23T18:55:08' -X 'github.com/go-authgate/authgate/internal/version.GitCommit=2234db1ceb3d7fb4a8a0fab3c6b19fc90620dd46' -X 'github.com/go-authgate/authgate/internal/version.GoVersion=go1.26.2' -X 'github.com/go-authgate/authgate/internal/version.BuildOS=darwin' -X 'github.com/go-authgate/authgate/internal/version.BuildArch=arm64'' -o release/linux/arm64/authgate . (which already depend on )

Closes #172

🤖 Generated with Claude Code
EOF
)

@appleboy @claude
docs(readme): use make instead of make build in build steps
2234db1 
- Replace `make build` with `make` in Quick Start and Build from Source
  so fresh clones run `generate` + `build` via the default `all` target
- Resolves #172 without the Makefile change proposed in #173

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 23, 2026 10:55
Copilot AI reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README build instructions so a fresh clone runs code generation before compiling, aligning the docs with the Makefile’s default all: generate build target and avoiding missing generated template files for new contributors.

Changes:

  • Replace make build with make in Quick Start build steps.
  • Replace make build with make in “Build from Source” steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +182 to +183
# Build the server (runs `generate` then `build` via the default `all` target)
make
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Quick Start prerequisites list Make as “optional”, but the updated build step now requires make (default all). To avoid confusing new contributors, either update the prerequisites to mark Make as required for these steps, or add an explicit non-make alternative build command sequence.

Copilot uses AI. Check for mistakes.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@appleboy appleboy merged commit 62b1787 into main Apr 23, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

fix: add generate dependency to build target

2 participants

@appleboy