Repository navigation
Say USAGE_REPORTING_ENABLED is unset in the Docker image - #54
Merged
Merged
Conversation
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>
Member
Author
|
Self-review rubric (performed inline in the same session; no independent reviewer was available):
Finding fixed during review: Out-of-diff observation: the This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
Stage A documentation accuracy sweep. Every documentation source of truth (
README.md,COMMANDS.md,CONFIG.md,USER_GUIDE.md,CHANGELOG.md) was checked againstapplication*.properties, the@Valuefields,BackupCommandLineRunner,BackupController,GitHubService,ScheduledBackupService,UsageReportingService,TraceInstallId,docker-entrypoint.sh,Dockerfile,docker-compose.ymland.env.example. One case of drift was found:CONFIG.md, Docker environment variables table: the "Default in the image" column gaveUSAGE_REPORTING_ENABLEDastrue. TheDockerfilesets onlyBACKUP_DIRECTORY,SCHEDULED_USERSandBACKUP_INTERVAL_MS, so the variable is unset in the image. The effectivetruecomes from the@Valuedefault inUsageReportingServiceand from the:-truefallback indocker-compose.yml. The row now says (unset) and explains where thetruecomes from, which matches how theTRACE_*rows in the same column are written.CHANGELOG.md: aFixedentry was added under[Unreleased].Found during the sweep and filed separately, because it is an image change rather than a documentation fix: #53 (the
Dockerfileinstalls agitbinary 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 SUCCESSDockerfileENVlines, theUsageReportingService@Valuedefault anddocker-compose.ymlThis 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