Skip to content

Clarify telemetry opt-out values - #46110

Closed
sanzanazaman wants to merge 1 commit into
github:mainfrom
sanzanazaman:patch-1
Closed

sanzanazaman wants to merge 1 commit into
github:mainfrom
sanzanazaman:patch-1

Conversation

@sanzanazaman

Copy link
Copy Markdown

Why:

The current wording does not make clear that DO_NOT_TRACK accepts only true or 1.
Closes: #45957

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

Clarifies the documented opt-out values for GH_TELEMETRY and DO_NOT_TRACK in the GitHub CLI telemetry article. The values were checked against the GitHub CLI environment variable reference.

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.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Sep 28, 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.

@UmeshCode1 UmeshCode1 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great clarification.

The previous phrasing ("Any falsy value works: 0, false, disabled, or an empty string. You can also use the DO_NOT_TRACK convention:") could easily mislead users into assuming DO_NOT_TRACK also required a falsy value to opt out, when in fact the DO_NOT_TRACK=1 / true console standard requires a truthy value to disable tracking.

Explicitly delineating the active opt-out values for both environment variables (GH_TELEMETRY falsy vs DO_NOT_TRACK truthy) resolves that ambiguity cleanly. Content linters and Playwright test suite are green. LGTM!

@subatoi

subatoi commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

As I noted here, we're not accepting contributions for this at this time, so I'm going to close this out

@sanzanazaman

Copy link
Copy Markdown
Author

Thanks for clarifying!

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

4 participants