chore: OSS polish round 3 before going public#33
Closed
blue4209211 wants to merge 1 commit into
Closed
Conversation
- README: replace `go install github.com/bitnami-labs/kubewatch@latest` with a `git clone + go build` flow; the install command resolved to the upstream repo, not this fork - delete `docs/CONTRIBUTION.md`, a stale older copy that pointed bug reports to bitnami-labs/kubewatch/issues (canonical guide is the root CONTRIBUTING.md) - delete `kubewatch-in-cluster.yaml`, a byte-identical duplicate of `kubewatch.yaml` (only README references the latter) - add `.DS_Store` to `.gitignore` so macOS metadata stops sneaking in Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request updates the .gitignore file to include .DS_Store, replaces the go install instructions in the README.md with a 'Building from source' guide, and removes the CONTRIBUTING.md file and a sample Pod manifest. The reviewer suggested using 'make build' instead of 'go build' in the documentation to ensure that versioning metadata is correctly embedded via the project's Makefile.
| # Clone and build kubewatch | ||
| $ git clone https://github.com/nudgebee/kubewatch.git | ||
| $ cd kubewatch | ||
| $ go build -o kubewatch |
There was a problem hiding this comment.
Using go build directly bypasses the LDFLAGS defined in the Makefile, which are used to embed versioning information (version, git commit, build date) into the binary. It is recommended to use make build to ensure the binary is built with the correct metadata.
Suggested change
| $ go build -o kubewatch | |
| $ make build |
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
Five small fixes before flipping the repo public — all mechanical, no behavior changes.
go install github.com/bitnami-labs/kubewatch@latestwith agit clone + go buildflow. The old command resolved to the upstream repo, not this fork — first-impression bug for anyone trying the local install path.docs/CONTRIBUTION.md: delete. Stale older copy of contributing docs that still directed bug reports tobitnami-labs/kubewatch/issues. Canonical guide is the rootCONTRIBUTING.md.kubewatch-in-cluster.yaml: delete. Byte-identical duplicate ofkubewatch.yaml(only the trailing newline differs); README only references the latter..gitignore: add.DS_Store. Two.DS_Storefiles were sitting untracked in the working tree and would have been committed by accident on the nextgit add -A..DS_Storefiles from the working tree.Deferred to follow-up PRs (per review):
github.com/bitnami-labs/kubewatchtogithub.com/nudgebee/kubewatch(touches ~20 source files + Dockerfile + Makefile, needs a product call)./opt/bitnami/...config path in the container image.docs/design.mddrift, CODEOWNERS expansion, dependabot docker grouping, slackwebhook stray-quote comment.Tests performed
git check-ignore .DS_Store pkg/.DS_Store— exits 0 after the gitignore change (was 1 before).kubewatch-in-cluster.yamlandkubewatch.yamlwere byte-identical viadiffbefore deletion.README.mdonly referenceskubewatch.yaml(notkubewatch-in-cluster.yaml) viagrep.Notes for reviewers
🤖 Generated with Claude Code