sneak
403ba4c42e
Add the canonical .golangci.yml (v2 schema, all linters enabled with a
small documented disable list) and pin the Dockerfile lint stage to
golangci/golangci-lint:v2.12.2 by tag and digest, replacing the old
v1.64.8 digest-only pin.
Fix all findings surfaced by the v1 to v2 jump without changing any
exported signatures or behavior:
- add package and exported-symbol doc comments (revive)
- rename unused handler parameters to underscore (revive)
- check or explicitly discard error returns (errcheck, errchkjson)
- wrap errors with %w instead of %v (err113)
- use http.NewRequestWithContext instead of http.Post (noctx)
- replace fmt.Println with fmt.Fprintln(os.Stdout, ...) (forbidigo)
- name magic numbers as constants (mnd)
- add explicit slog.LevelDebug case (exhaustive)
- interface{} to any (modernize)
- move tests to the simplelog_test package (testpackage) and add
t.Parallel() (paralleltest)
- move NewWebhookHandler above its methods (funcorder)
- whitespace, line-length, and blank-line fixes (wsl_v5, whitespace,
nlreturn, lll, embeddedstructfieldcheck)
- nolint with justification for the intentional init/global design
(gochecknoinits, gochecknoglobals) and interface-returning
constructor (ireturn)
58 lines
2.3 KiB
Markdown
58 lines
2.3 KiB
Markdown
# Workflow
|
|
|
|
* branch (from `main`)
|
|
* do the work in Next Step
|
|
* move Next Step to the top of Completed Steps
|
|
* move the top item of Future Steps into Next Step
|
|
* commit (`TODO.md` changes in the same commit as the work)
|
|
* merge to `main` if the branch is not protected, otherwise open a PR
|
|
* push
|
|
|
|
# Status
|
|
|
|
1.0+
|
|
|
|
Tagged v1.0.0 (2024-06-14) and 1.0.1 (2026-02-08). In post-1.0
|
|
maintenance; the library is referenced by the Go styleguide.
|
|
|
|
# Next Step
|
|
|
|
Bring the Makefile up to policy in one commit: add fmt-check, check, and
|
|
hooks targets (test/lint/fmt/docker exist) and add the missing policy
|
|
files it depends on: .golangci.yml, REPO_POLICIES.md, .editorconfig,
|
|
.dockerignore, and .gitea/workflows/check.yml running make check.
|
|
|
|
# Completed Steps
|
|
|
|
* 2026-08-07: added canonical `.golangci.yml` (v2 schema), pinned the
|
|
`Dockerfile` lint stage to golangci-lint v2.12.2 (tag+digest), and
|
|
fixed all findings the v1→v2 jump surfaced without changing any
|
|
exported signatures or behavior
|
|
* 2026-02-08: fixed JSONHandler deadlock from recursive log.Println,
|
|
with regression test; tagged 1.0.1
|
|
* 2024-06-14: 1.0 prep: lint and fmt enforced in Docker build, call
|
|
stack depth fix so log locations report correctly, example script,
|
|
removed non-building RELP code; tagged v1.0.0
|
|
* 2024-05-22: module path moved to sneak.berlin/go/simplelog
|
|
* 2024-05-14: initial library: slog-based console, JSON, webhook, and
|
|
RELP handlers, MultiplexHandler, caller file/line info, UTC ISO
|
|
timestamps, level-colored output
|
|
|
|
# Future Steps
|
|
|
|
* Rewrite the Dockerfile to run make check with sha256-pinned base
|
|
images (currently golangci/golangci-lint:latest and golang:1.22,
|
|
unpinned, duplicating Makefile logic instead of calling it)
|
|
* Restructure README.md into the standard sections: Description,
|
|
Getting Started, Rationale, Design, TODO, License, Author
|
|
* Delete the old plain TODO file once this TODO.md lands
|
|
* Add .aider.* to .gitignore and remove the stray aider artifacts from
|
|
the working tree
|
|
* Pick one tag scheme before the next release (v1.0.0 vs 1.0.1 are
|
|
inconsistent)
|
|
* Fix RELP output to cache (from old TODO)
|
|
* Re-add RELP delivery over TCP to remote rsyslog imrelp; removed
|
|
2024-06-14 because it did not build (README planned feature)
|
|
* Add regex filtering for webhook logs (from old TODO)
|
|
* Better console output format (from old TODO)
|