docs: expand Build from source with run, lint, and test details#16
Closed
ryans-posthog wants to merge 1 commit intomasterfrom
Closed
docs: expand Build from source with run, lint, and test details#16ryans-posthog wants to merge 1 commit intomasterfrom
ryans-posthog wants to merge 1 commit intomasterfrom
Conversation
Adds guidance to the top-level README's "Build from source → For development" section so that a reader who just ran `go build` has a path to actually running, testing, and linting the result: - Show `./caddy version` and `./caddy run --config ...` after the build fence, and point at `./caddy help` / command-line docs - Note macOS and Windows equivalents alongside the Linux setcap tip - Mention the race-detector test run used by CI and the existing integration tests under caddytest/ - Document the repo's existing .golangci.yml and .pre-commit-config.yaml so contributors can discover and install them No code or config is changed; only README.md. Generated-By: PostHog Code Task-Id: 4831e9d8-43a6-499c-8515-78be49215c18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
go buildhas a clear next step: verify the binary (./caddy version), run it (./caddy run --config ...), and discover the full CLI via./caddy help.setcaptip (previously Linux-only).-raceflag (matches CI, see.github/workflows/ci.yml:137) and the integration tests undercaddytest/..golangci.ymland.pre-commit-config.yamlso contributors can discover and install the tooling that already ships with the repo.Only
README.mdis touched — no code, config, or new files.Test plan
cd cmd/caddy && go build && ./caddy versionsucceeds.go test -race ./...runs (smoke: one package is fine).golangci-lint runpicks up.golangci.yml.pre-commit install && pre-commit run --all-filesruns the configured hooks.