Skip to content

Tell the user we collect telemetry when install finishes - #17

Merged
zmofei merged 3 commits into
mainfrom
docs/telemetry-install-notice
Sep 15, 2026
Merged

zmofei merged 3 commits into
mainfrom
docs/telemetry-install-notice

Conversation

@zmofei

@zmofei zmofei commented Sep 15, 2026

Copy link
Copy Markdown
Member

Adds a one-time notice to both installers, printed right after the "Installed $version" summary, saying we collect telemetry and how to turn it off. Skipped when telemetry is already off (nothing to opt out of).

Points readers at the CLI's README (#telemetry) for the full explanation of what's collected and why — see mapbox/mapbox-cli-private (companion PR, pending).

Manually verified:

  • scripts/test-install.sh passes.
  • sh -n and shellcheck -s sh clean on install.sh.

mattpodwysocki

This comment was marked as resolved.

mattpodwysocki
mattpodwysocki previously approved these changes Sep 15, 2026
Points to the CLI's README for the full explanation and how to opt out
with MAPBOX_CLI_NO_TELEMETRY=1. Skipped when telemetry is already off.
…tion

Shorten the message and link straight to
https://github.com/mapbox/mapbox-cli#privacy instead of $REPO/$Repo,
since that variable's placeholder value doesn't point at the real repo.
@zmofei
zmofei force-pushed the docs/telemetry-install-notice branch from 38ab91e to bd88fd5 Compare September 15, 2026 06:04
Matches the wording review feedback asked for: states the default
plainly, names the exact env var and when to set it, and separates
the pointer to more detail rather than bundling it with the opt-out
line.
@zmofei
zmofei marked this pull request as ready for review September 15, 2026 07:24
@zmofei
zmofei requested a review from a team as a code owner September 15, 2026 07:24

@datasveta datasveta 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.

Two things to be implemented in future version (already listed in readme):

  • In addition to the command group (command/styles, command/auth), the specific subcommand like login

  • Exit-code telemetry

@datasveta
datasveta self-requested a review September 15, 2026 09:03
@zmofei
zmofei merged commit cdf71c9 into main Sep 15, 2026
8 checks passed
@mapbox mapbox deleted a comment from mattpodwysocki Sep 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants