fix: harden runtime paths and improve project discovery - #1
Merged
Conversation
Expand the root package doc (doc.go) and add a package doc for the public tui package (tui/doc.go) so both render on pkg.go.dev and via 'go doc'. Remove the redundant one-line package comment from tui/tui.go so each package has a single authoritative doc.
Honor cancellation while reading connection tables, avoid double-counting Linux guest CPU time, and isolate mutable snapshots returned to callers. Bound process collection by local passwd data and make collector lifecycle shutdown idempotent.
Strip C0, C1, CSI, OSC, and related control sequences from host and process fields before rendering them. Cover compact, panel, process, tree, and confirmation views while removing obsolete rendering helpers.
Reject invalid or misplaced CLI and web options, require authentication for non-loopback web binds, and bound background update cleanup. Sanitize host and process text before terminal output without changing JSON contracts.
Revalidate cached release metadata before installation, honor canceled checks, reject non-regular cache entries, and replace binaries through unique synced temporary files with reliable cleanup.
Bound CLI and API network probes, enforce same-origin and loopback Host checks, cap WebSocket clients and queues, and synchronize startup and shutdown. Render browser process data through DOM text properties instead of untrusted HTML.
Run formatting, module tidiness, tests, race detection, vet, and smoke checks before release publishing, with write permission scoped to the release job. Align contributor validation with CI.
Add install, upgrade, checksum, and documentation guidance to generated releases and align Linux package metadata with the project's current positioning.
Clarify vminfo positioning, installation paths, comparisons, platform support, FAQ, documentation links, and library usage. Add structured issue forms plus security, support, and pull request guidance.
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
Security and compatibility
ps/killbehavior and cross-platformsummary/watchsupportValidation
go test ./...go test -race ./...go vet ./...go mod tidy -diffgo mod verifygofmtandgit diff --checkgoreleaser checkgoreleaser release --snapshot --cleango run ./cmd/vminfo versiongo run ./cmd/vminfo summary --jsongo run ./cmd/vminfo watch --count 1go run ./cmd/vminfo ps --limit 5Documentation
The canonical VitePress documentation and comparison pages are maintained in
cloudapp3/vmdocsand have already been deployed to https://vminfo.bestcheapvps.org/.No release tag is created by this PR.