-
Notifications
You must be signed in to change notification settings - Fork 32
Open
Labels
Description
Summary
Align beekeeper CI with ethersphere/bee by adding commit message linting, PR title linting, and optionally other quality checks. This keeps conventions consistent across swarm repos and catches bad commits/PR titles before merge.
Current state
- go.yml: build, lint (golangci-lint), vet, test on PR; matrix for ubuntu/macos/windows.
- release.yaml: goreleaser on tag push.
No commit or PR title checks today.
Proposed additions
1. Commit lint (on PR)
- Lint all commits in a PR against Conventional Commits (e.g.
feat:,fix:,chore:, etc.). - Reference: bee uses wagoid/commitlint-github-action@v5.
- Add
commitlint.config.jsat repo root (can mirror or adapt bee’s config, e.g. header max length 98 to match your convention).
2. PR title lint
- Ensure PR title follows the same convention as commits (so merge commit message is valid).
- Reference: bee’s pr-title.yml runs on
pull_request(opened, synchronize, reopened, edited), uses@commitlint/cli+@commitlint/config-conventionaland pipesgithub.event.pull_request.titlethrough commitlint. - Add a dedicated workflow (e.g.
.github/workflows/pr-title.yml) or a job in an existing workflow that runs this check.
3. Optional (nice-to-have)
- Paths / branches: like bee, optionally restrict when go workflow runs (e.g.
paths-ignore, or only certain branches) to save CI time. - Whitespace / tidy: bee runs
make check-whitespaceand katexochen/go-tidy-check; add if we want to enforcego mod tidyand whitespace.
References
Reactions are currently unavailable