Skip to content

Clarify that DO_NOT_TRACK only accepts 1 or true - #46877

Open
amkkoussay wants to merge 1 commit into
github:mainfrom
amkkoussay:clarify-do-not-track-values
Open

amkkoussay wants to merge 1 commit into
github:mainfrom
amkkoussay:clarify-do-not-track-values

Conversation

@amkkoussay

@amkkoussay amkkoussay commented Nov 8, 2026 •

Copy link
Copy Markdown

Why:
The "How to opt out" section of the GitHub CLI telemetry article explains that any falsy value works for GH_TELEMETRY, then introduces DO_NOT_TRACK without noting that it follows different rules. In cli/cli, ParseTelemetryState (internal/telemetry/telemetry.go) only disables telemetry for DO_NOT_TRACK when its value is exactly 1 or true, so a reader could set, for example, DO_NOT_TRACK=yes and 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:

Unlike GH_TELEMETRY, DO_NOT_TRACK only disables telemetry when it is set to 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.

Copilot AI lite review requested due to automatic review settings November 8, 2026 15:13
@github-actions

github-actions Bot commented Nov 8, 2026

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
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19

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

🤖 This comment is automatically generated.

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 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_TRACK disables telemetry only when set to 1 or true.
  • Distinguishes DO_NOT_TRACK behavior from the broader falsy-value handling of GH_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

This branch has not been deployed

No deployments
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.

2 participants