docs: clarify DO_NOT_TRACK values for GitHub CLI telemetry opt-out - #45982
BaconMan1168 wants to merge 1 commit into
Conversation
DO_NOT_TRACK only disables telemetry when set to 1 or true, unlike GH_TELEMETRY which accepts any falsy value.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
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. |
|
Thank you for opening a PR for this, but since this hasn't been approved for a contribution yet, I'm going to close this out. You can read more about contributing to the GitHub docs here |
Why:
Closes: #45957
The page says any falsy value disables telemetry, then introduces
DO_NOT_TRACK. That reads as ifDO_NOT_TRACKaccepts any falsy or truthy value, but the CLI only honors1ortrue.What's being changed (if available, include any code snippets, screenshots, or gifs):
In
github-cli-telemetry.md, one sentence added after theDO_NOT_TRACKmention: unlikeGH_TELEMETRY,DO_NOT_TRACKonly disables telemetry when set to1ortrue, and other values such asyesorenabledhave no effect.Source for the behavior:
ParseTelemetryStateincli/cliinternal/telemetry/telemetry.go, which lowercases and trims the value and disables telemetry only for1ortrue.Check off the following: