Skip to content

Say USAGE_REPORTING_ENABLED is unset in the Docker image - #54

Merged
dmccoystephenson merged 2 commits into
mainfrom
feature/docker-usage-reporting-default
Oct 31, 2026
Merged

dmccoystephenson merged 2 commits into
mainfrom
feature/docker-usage-reporting-default

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Stage A documentation accuracy sweep. Every documentation source of truth (README.md, COMMANDS.md, CONFIG.md, USER_GUIDE.md, CHANGELOG.md) was checked against application*.properties, the @Value fields, BackupCommandLineRunner, BackupController, GitHubService, ScheduledBackupService, UsageReportingService, TraceInstallId, docker-entrypoint.sh, Dockerfile, docker-compose.yml and .env.example. One case of drift was found:

  • CONFIG.md, Docker environment variables table: the "Default in the image" column gave USAGE_REPORTING_ENABLED as true. The Dockerfile sets only BACKUP_DIRECTORY, SCHEDULED_USERS and BACKUP_INTERVAL_MS, so the variable is unset in the image. The effective true comes from the @Value default in UsageReportingService and from the :-true fallback in docker-compose.yml. The row now says (unset) and explains where the true comes from, which matches how the TRACE_* rows in the same column are written.
  • CHANGELOG.md: a Fixed entry was added under [Unreleased].

Found during the sweep and filed separately, because it is an image change rather than a documentation fix: #53 (the Dockerfile installs a git binary that the JGit-based application never uses).

No tracking issue: this gap was found during triage.

Deferred: #8 (the README links to a missing LICENSE). Adding a license needs a maintainer decision on the license, holder and year.

Test plan

  • mvn test: 185 tests ran, 0 failures, 0 errors, 1 skipped, BUILD SUCCESS
  • The edited row was checked against the Dockerfile ENV lines, the UsageReportingService @Value default and docker-compose.yml
  • CI green on the PR head

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

dmccoystephenson and others added 2 commits October 30, 2026 20:10
The Dockerfile sets no USAGE_REPORTING_ENABLED, so the CONFIG.md table's
"Default in the image" of true was wrong; the true comes from the
application default and docker-compose.yml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (performed inline in the same session; no independent reviewer was available):

  • Scope: PASS — only CONFIG.md (one table row) and CHANGELOG.md (one Fixed entry) are modified; both are needed for the single drift fix.
  • Tests-new: PASS (not applicable) — no code was added.
  • Tests-fix: PASS (not applicable) — documentation-only; there is no behavior to stash and re-run.
  • Sibling structure: PASS — the row now uses (unset), the same form as the GITHUB_TOKEN, TRACE_USAGE_REPORTING, DO_NOT_TRACK and TRACE_INSTALL_ID rows when the Dockerfile sets no ENV.
  • Sibling renames: PASS (not applicable) — nothing renamed.
  • Docs: PASS — README.md, COMMANDS.md and USER_GUIDE.md make no claim about the image default; CHANGELOG.md [Unreleased] records the fix.
  • Issue resolution: PASS (not applicable) — no Closes; the gap was found during triage.
  • CI: PASS — build and docker-build are both green on the head commit; mvn test locally ran 185 tests with 0 failures.
  • Config-doc parity / Command-doc parity / Package placement: PASS (not applicable) — no new keys, flags, endpoints or classes.
  • No credential leakage: PASS — no secrets touched.

Finding fixed during review: CONFIG.md:192 — the first wording said docker-compose.yml passes true "unless .env sets it". The :-true fallback also replaces a set-but-empty value, so the wording was changed to "unless .env gives it a non-empty value" (commit pushed; CI re-run green).

Out-of-diff observation: the Dockerfile installs a git package that the JGit-based application does not use, and its comment says it is required. This was filed as #53 rather than changed here.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit ac904b1 into main Oct 31, 2026
2 checks passed
@dmccoystephenson
dmccoystephenson deleted the feature/docker-usage-reporting-default branch October 31, 2026 02:13
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.

Dockerfile installs a git binary the application never uses

1 participant