Make godeploy an installable single-host prototype - #16
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
README installation/tutorial instructions for godeploy-proxy are inconsistent and can lead to a broken walkthrough.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR makes godeploy-platform installable via go install by adopting the canonical module path, adds a runnable godeploy-proxy command to the build/release outputs, and updates public-facing docs to reflect the project’s single-host prototype maturity and operational constraints.
Changes:
- Switch Go module path to
github.com/enoquesousa/godeploy-platformand update in-repo imports accordingly. - Add
cmd/godeploy-proxy, wire it intomake buildand GoReleaser archives, and documentGODEPLOY_PROXY_ADDR. - Remove internal planning/progress notes and local artifact files; update README/docs positioning and limitations.
File summaries
| File | Description |
|---|---|
| README.md | Updates installation guidance, tutorial proxy workflow, architecture list, maturity/limitations, and config table. |
| PLAN_PROGRESS.md | Removes internal planning/progress notes from the public tree. |
| Makefile | Adds build-proxy target and includes proxy in build. |
| internal/webhook/example_test.go | Updates imports to canonical module path. |
| internal/scheduler/scheduler.go | Updates imports to canonical module path. |
| internal/scheduler/scheduler_test.go | Updates imports to canonical module path. |
| internal/proxy/store.go | Updates imports to canonical module path. |
| internal/pipeline/pipeline.go | Updates imports to canonical module path. |
| internal/pipeline/pipeline_test.go | Updates imports to canonical module path. |
| internal/observability/ws_logs.go | Updates imports to canonical module path. |
| internal/observability/stats.go | Updates imports to canonical module path. |
| internal/observability/observability_test.go | Updates imports to canonical module path. |
| internal/detector/example_test.go | Updates imports to canonical module path. |
| internal/builder/templates.go | Updates imports to canonical module path. |
| internal/builder/builder.go | Updates imports to canonical module path. |
| internal/builder/builder_test.go | Updates imports to canonical module path. |
| go.mod | Changes module declaration to the canonical GitHub path. |
| docs/deployment.md | Reframes reverse proxy docs around the godeploy-proxy binary and its polling behavior. |
| coverage | Removes stray local coverage artifact file. |
| cover | Removes stray local coverage artifact file. |
| cmd/godeployd/routes.go | Updates imports to canonical module path. |
| cmd/godeployd/main.go | Updates imports to canonical module path. |
| cmd/godeployd/main_test.go | Updates imports to canonical module path. |
| cmd/godeploy-tui/main.go | Updates imports to canonical module path. |
| cmd/godeploy-proxy/main.go | Adds the runnable reverse proxy command wiring SQLite + proxy runner + env config. |
| cmd/godeploy-proxy/main_test.go | Adds unit test for getenv behavior in the proxy command. |
| cmd/godeploy-logtail/main.go | Updates imports to canonical module path. |
| CHANGELOG.md | Documents the proxy command, module path change, and artifact cleanup. |
| .goreleaser.yaml | Adds proxy build definition and includes it in release archives. |
| .env.example | Documents GODEPLOY_PROXY_ADDR and clarifies shared DB usage. |
| err.txt | Removed local artifact (no longer present in the tree). |
Review details
- Files reviewed: 32/33 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
111
to
+112
| go install github.com/enoquesousa/godeploy-platform/cmd/godeployd@latest | ||
| go install github.com/enoquesousa/godeploy-platform/cmd/godeploy-proxy@latest |
| } | ||
| GO | ||
| GODEPLOY_DB=$(pwd)/godeploy.db go run ./cmd/godeploy-proxy-dev | ||
| GODEPLOY_DB=$(pwd)/godeploy.db GODEPLOY_PROXY_ADDR=:8090 ./bin/godeploy-proxy |
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
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
Validation
Release follow-up
After this PR is green and merged, publish the first v0.1.0 GitHub release from the documented changelog.