docs: align ALLURE_NO_ANALYTICS opt-out example with implementation#3333
Merged
baev merged 2 commits intoMay 11, 2026
Merged
Conversation
2 tasks
Member
|
update Analytics.md instead |
Both opt-out paths (GaPlugin server-side and the HTML template via ReportWebGenerator) treat ALLURE_NO_ANALYTICS through Boolean.parseBoolean / "any non-null value disables" semantics. In practice the only value that reliably disables analytics on both sides is "true". The previously documented example "export ALLURE_NO_ANALYTICS=1" does not disable HTML-side analytics, leaving gtag.js loading from googletagmanager.com in the rendered report. Update Analytics.md to recommend "true" so the documented opt-out actually works end-to-end. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
b2c07b8 to
2f36d89
Compare
baev
approved these changes
May 11, 2026
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.
Context
Analytics.mddocuments the opt-out as:export ALLURE_NO_ANALYTICS=1The two halves of the analytics path use different semantics on this variable:
GaPlugin(server-side): any non-null value disables →=1works.ReportWebGenerator(HTML side): parses throughBoolean.parseBoolean, which only treats"true"(case-insensitive) as a disable signal →=1is ignored, andgtag.jsstill loads fromgoogletagmanager.comin the rendered report.So the documented opt-out only half-works. The implementation already honours
=trueend-to-end — covered by the existingReportWebGeneratorTest#shouldDisableAnalytics, which was further tightened (and the template's stray inlinegtag('config', …)block was moved inside theanalyticsDisableguard) in #3332.The cheapest fix is to update the documentation to recommend the value the implementation honours. Net diff: one line in
Analytics.md.Checklist
shouldDisableAnalyticsalready exercises the=truepath)