lerkolabs/uptop
1
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs: community polish for public readiness #21

Merged
lerko merged 6 commits from chore/community-polish into main 2026-05-24 19:40:01 +00:00
Conversation 0 Commits 6 Files Changed 7
+141 -2
lerko commented 2026-05-24 18:16:18 +00:00
Owner
Copy Link
Copy Source

Summary

  • Add --version flag with build metadata injection via ldflags
  • Update LICENSE with dual copyright (original author + current maintainer)
  • Add CHANGELOG.md with release history from existing tags
  • Add CONTRIBUTING.md (dev setup, test commands, PR guidelines)
  • Add SECURITY.md (disclosure policy, scope)
  • Add install instructions (source, Docker, binary) and Kuma migration guide to README

Principles

No badge parade, no emoji marketing, no "please star" energy. Just useful information, clearly presented.

Test plan

  • goupkeep version prints version info
  • goupkeep --version and -v also work
  • Dev build shows "go-upkeep dev"
  • go test ./... passes
  • golangci-lint run ./... clean
  • Review each doc for tone
## Summary - Add `--version` flag with build metadata injection via ldflags - Update LICENSE with dual copyright (original author + current maintainer) - Add CHANGELOG.md with release history from existing tags - Add CONTRIBUTING.md (dev setup, test commands, PR guidelines) - Add SECURITY.md (disclosure policy, scope) - Add install instructions (source, Docker, binary) and Kuma migration guide to README ## Principles No badge parade, no emoji marketing, no "please star" energy. Just useful information, clearly presented. ## Test plan - [x] `goupkeep version` prints version info - [x] `goupkeep --version` and `-v` also work - [x] Dev build shows "go-upkeep dev" - [x] `go test ./...` passes - [x] `golangci-lint run ./...` clean - [x] Review each doc for tone
lerko added 5 commits 2026-05-24 18:16:18 +00:00
feat: add --version flag with build metadata injection 8f9210b451 
Supports `goupkeep version`, `--version`, and `-v`. Prints version,
commit hash, and build date when injected via ldflags. Shows "dev"
for local builds. Dockerfile updated with ARGs for version injection.
chore: update LICENSE with dual copyright for independent fork 611f26846c
docs: add CHANGELOG.md with release history 1e0ae22447
docs: add CONTRIBUTING.md deb7d017af
docs: add SECURITY.md with disclosure policy 09e1bec9a3
lerko added 1 commit 2026-05-24 19:33:15 +00:00
docs: add install instructions and Kuma migration guide to README
CI / test (pull_request) Successful in 4m36s
Details
CI / lint (pull_request) Successful in 1m2s
Details
1fa2b1d98c
lerko force-pushed chore/community-polish from d1bd66deb3 to 1fa2b1d98c 2026-05-24 19:33:15 +00:00 Compare
lerko merged commit d03dc0c1ea into main 2026-05-24 19:40:01 +00:00
lerko deleted branch chore/community-polish 2026-05-24 19:40:01 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
lerko (Tyler Koenig)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lerkolabs/uptop#21
Delete Branch "chore/community-polish"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?