Skip to content

chore: bring repo up to ProbeLab standard - #20

Merged
dennis-tra merged 8 commits into
mainfrom
chore/repo-standard
Nov 6, 2026
Merged

dennis-tra merged 8 commits into
mainfrom
chore/repo-standard

Conversation

@dennis-tra

Copy link
Copy Markdown
Contributor

What and why

Brings parsec up to the ProbeLab repository standard. One commit per item.

  • License: this public repo gets the PolyForm Strict License 1.0.0. There was no LICENSE file, and the README said MIT. Reviewers: please confirm this is intended. The README license line now links the new file.
  • AGENTS.md follows the template and holds repo facts only. It was already moved out of CLAUDE.md; no other tool-specific instruction files exist.
  • justfile gets lint and ci (lint, build, test); test takes extra arguments; format also runs go fix. The existing recipes (build, docker, database, migrations) stay.
  • .gitignore ignores .env. .env.example lists every variable the code reads, with defaults and no secrets.
  • README gains Quickstart, Configuration, Metrics, Development and Deployment.
  • push.yml becomes ci.yml: the shared go.yml@v1 and image.yml@v1 workflows plus a final ci-ok job. The image keeps the same ECR repository, role and tag (parsec-sha<commit>). The old workflow only tested on push to main; pull requests now run lint and test too, and gofumpt and staticcheck are installed through go-tools.
  • staticcheck.conf turns off 5 checks for existing findings (SA1016, SA1019, SA1029, SA4009, U1000) so just lint passes without code changes. Fixing them is left for follow-up changes.

Left out on purpose:

  • No deploy.yml and no deploy job: parsec has no Deploy workflow today.
  • No CHANGELOG.md: the repo publishes no releases.
  • Metrics use the Prometheus client directly, not go-commons telemetry, so the names do not follow the probelab-telemetry rules. The README documents the current names. No Grafana dashboard link is in the README.
  • go fix -diff shows pending changes (any, range loops); lint does not fail on them, and I did not apply them.

How I checked it

  • just ci passed locally (go fix -diff, go vet, staticcheck, build, test). Staticcheck on this machine was built with an older Go than go.mod needs, so I ran it from a freshly installed honnef.co/go/tools/cmd/staticcheck@latest (v0.8.2). Most packages have no tests; only pkg/util has any.
  • The new ci.yml has not run yet. Its result on this pull request is the first check. I did not run actionlint.

Deploy

Nothing to deploy. After merge, add ci-ok as the required check in the branch rules of main. The old Push docker image workflow no longer exists, so remove it from any rule that requires it.

@dennis-tra
dennis-tra merged commit 976edb2 into main Nov 6, 2026
4 checks passed
@dennis-tra
dennis-tra deleted the chore/repo-standard branch November 6, 2026 09:33
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