Skip to content

chore: OSS polish round 3 before going public#33

Closed
blue4209211 wants to merge 1 commit into
masterfrom
chore/oss-polish-before-public
Closed

chore: OSS polish round 3 before going public#33
blue4209211 wants to merge 1 commit into
masterfrom
chore/oss-polish-before-public

Conversation

@blue4209211

Copy link
Copy Markdown
Contributor

Summary

Five small fixes before flipping the repo public — all mechanical, no behavior changes.

  • README: replace go install github.com/bitnami-labs/kubewatch@latest with a git clone + go build flow. 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 to bitnami-labs/kubewatch/issues. Canonical guide is the root CONTRIBUTING.md.
  • kubewatch-in-cluster.yaml: delete. Byte-identical duplicate of kubewatch.yaml (only the trailing newline differs); README only references the latter.
  • .gitignore: add .DS_Store. Two .DS_Store files were sitting untracked in the working tree and would have been committed by accident on the next git add -A.
  • Cleaned up the two stray .DS_Store files from the working tree.

Deferred to follow-up PRs (per review):

  • Renaming the Go module path from github.com/bitnami-labs/kubewatch to github.com/nudgebee/kubewatch (touches ~20 source files + Dockerfile + Makefile, needs a product call).
  • Changing the /opt/bitnami/... config path in the container image.
  • RBAC sample, docs/design.md drift, CODEOWNERS expansion, dependabot docker grouping, slackwebhook stray-quote comment.

Tests performed

  • Ran git check-ignore .DS_Store pkg/.DS_Store — exits 0 after the gitignore change (was 1 before).
  • Confirmed kubewatch-in-cluster.yaml and kubewatch.yaml were byte-identical via diff before deletion.
  • Confirmed README.md only references kubewatch.yaml (not kubewatch-in-cluster.yaml) via grep.
  • Rendered the updated README install section locally to confirm the code block still formats cleanly.

Notes for reviewers

  • No code changes, no Dockerfile changes, no manifest changes beyond the duplicate deletion. CI should be a no-op other than the docs check.

🤖 Generated with Claude Code

- 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>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread README.md
# Clone and build kubewatch
$ git clone https://github.com/nudgebee/kubewatch.git
$ cd kubewatch
$ go build -o kubewatch

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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

@blue4209211 blue4209211 deleted the chore/oss-polish-before-public branch May 19, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant