Repository navigation
Clarify that DO_NOT_TRACK only accepts 1 or true - #46877
amkkoussay wants to merge 1 commit into
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
🟢 Approval recommended
The review records no active issues, and the narrowly scoped documentation update clarifies the accepted telemetry opt-out values.
No open issues 🎉
What changed in this PR
This pull request clarifies the accepted values for DO_NOT_TRACK when opting out of GitHub CLI telemetry.
Changes:
- Documents that
DO_NOT_TRACKdisables telemetry only when set to1ortrue. - Distinguishes
DO_NOT_TRACKbehavior from the broader falsy-value handling ofGH_TELEMETRY.
| File | Description |
|---|---|
content/github-cli/github-cli/github-cli-telemetry.md |
Clarifies the accepted DO_NOT_TRACK values in the telemetry opt-out instructions. |
Review effort: Lite
Why:
The "How to opt out" section of the GitHub CLI telemetry article explains that any falsy value works for
GH_TELEMETRY, then introducesDO_NOT_TRACKwithout noting that it follows different rules. Incli/cli,ParseTelemetryState(internal/telemetry/telemetry.go) only disables telemetry forDO_NOT_TRACKwhen its value is exactly1ortrue, so a reader could set, for example,DO_NOT_TRACK=yesand believe they had opted out when they have not.Closes:
#45957
What's being changed (if available, include any code snippets, screenshots, or gifs):
Adds one sentence to the "How to opt out" section of
content/github-cli/github-cli/github-cli-telemetry.md:Check off the following: