Add homelab CD pipeline, semantic releases, MIT license, and docs#3
Merged
Conversation
docs: add MIT license, deployment guide, contributing guide, and PR template
docs: add MIT license, deployment guide, contributing guide, and PR template
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
Adds an end-to-end release-and-deploy pipeline for Pulse, project licensing,
docs, and a committed commit-policy guardrail. On merge to
main, release-pleaseproposes a version; merging the release PR tags
vX.Y.Z, builds and pushes theimage to GHCR, and deploys to the homelab over Netbird + SSH. Tests gate every
step.
What's included
CI/CD
release-please.yml— semantic versioning from Conventional Commits (config + manifest seeded at0.0.0).release.yml— now: test → build/push GHCR image → deploy job (needs: release) that joins Netbird, SSHes toubuntu@10.2.0.115, and runsdocker compose pull && up -d. Release/changelog ownership moved to release-please.deploy/docker-compose.homelab.yml— pullsghcr.io/memetics19/pulse(no local build).Build fix / refactor
is_activeis now a real Gobool(monitors + infra_agents) via sqlc column override + regeneration, with all consumers,the import CLI, and the admin UI updated.
Guardrail
.githooks/{commit-msg,pre-commit}+CONTRIBUTING.md: reject AI/co-author trailers and un-gofmt'd Go. Enable withgit config core.hooksPath .githooks.Project / docs
LICENSE.md(MIT) referenced from README.docs/deployment.md(in nav), status-page GIF wiring + capture recipe, getting-started import/clone-URL fixes.Breaking change
is_activein monitor and agent JSON is now boolean (true/false) instead ofinteger (
0/1), on both request and response sides of/api/monitorsand/api/agents. The bundled UI and CLI are updated; external API clients must adapt.Before deploy works (post-merge)
NETBIRD_SETUP_KEY,NETBIRD_MANAGEMENT_URL(if self-hosted),SSH_PRIVATE_KEY,SSH_HOST_FINGERPRINT,DEPLOY_HOST=10.2.0.115,DEPLOY_USER=ubuntu. (PULSE_TOKENexists.)10.2.0.115: docker+compose,git clone … ~/pulse, authorize deploy key, GHCR package public ordocker login,docker compose -f deploy/docker-compose.homelab.yml up -d(seedocs/deployment.md).docs/assets/status-page.gif(README embed is commented out until then).git config core.hooksPath .githookslocally to activate the guardrail.Test plan / verification
go build+go test ./... -count=1: api 18 pkgs ✓, agent ✓, cli ✓npx tsc --noEmit✓release-please-*.jsonvalid ✓docker compose -f deploy/docker-compose.homelab.yml config✓commit-msghook tested: rejects co-author/attribution, accepts clean ✓