Skip to content

docs: clarify DO_NOT_TRACK values for GitHub CLI telemetry opt-out - #45982

Closed
BaconMan1168 wants to merge 1 commit into
github:mainfrom
BaconMan1168:docs-45957-clarify-do-not-track-values
Closed

BaconMan1168 wants to merge 1 commit into
github:mainfrom
BaconMan1168:docs-45957-clarify-do-not-track-values

Conversation

@BaconMan1168

Copy link
Copy Markdown
Contributor

Why:

Closes: #45957

The page says any falsy value disables telemetry, then introduces DO_NOT_TRACK. That reads as if DO_NOT_TRACK accepts any falsy or truthy value, but the CLI only honors 1 or true.

What's being changed (if available, include any code snippets, screenshots, or gifs):

In github-cli-telemetry.md, one sentence added after the DO_NOT_TRACK mention: unlike GH_TELEMETRY, DO_NOT_TRACK only disables telemetry when set to 1 or true, and other values such as yes or enabled have no effect.

Source for the behavior: ParseTelemetryState in cli/cli internal/telemetry/telemetry.go, which lowercases and trims the value and disables telemetry only for 1 or true.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

DO_NOT_TRACK only disables telemetry when set to 1 or true, unlike GH_TELEMETRY which accepts any falsy value.
@welcome

welcome Bot commented Sep 21, 2026

Copy link
Copy Markdown

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.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Sep 21, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
github-cli/github-cli/github-cli-telemetry.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@subatoi

subatoi commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

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

@subatoi subatoi closed this Sep 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify that DO_NOT_TRACK only disables telemetry if 1 or true

3 participants