Skip to content

docs(packs): remove the duplicated Private packs section and correct what telemetry sends - #2793

Merged
merill merged 1 commit into
mainfrom
docs/private-pack-wording
Nov 11, 2026
Merged

merill merged 1 commit into
mainfrom
docs/private-pack-wording

Conversation

@merill

@merill merill commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

What changes

Only website/docs/packs/index.md.

How it was checked

Read against powershell/internal/session/Write-Telemetry.ps1 for what a run sends. The page was not built or previewed after this change; it is a text-only edit.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated private-pack installation guidance to explain the order in which GitHub sign-in methods and tokens are checked, including how to provide a CLI or vault token.
    • Clarified that tokens are sent only to GitHub’s API and are not stored, and advised using CLI sign-in or -Token outside pipelines.
    • Documented that session processes inherit environment variables, private-pack telemetry reports test totals unless disabled, and local-folder packs are not identified to Maester.

…what telemetry sends

Two pull requests that both edited the Private packs section left it on
the page twice, the first copy still describing the token in an
environment variable as the only way. The stale copy is removed.

The page said nothing about a private pack is sent to Maester. A run's
telemetry never names it, but its totals do count the pack's tests, so
the sentence now says that.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@merill
merill requested a review from a team as a code owner November 11, 2026 08:18
@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The private-pack documentation now describes an ordered GitHub sign-in lookup, clarifies which run totals telemetry reports, and states that local-folder packs are treated as private.

Changes: Private-pack documentation

Layer / File(s) Summary
Private-pack authentication and privacy guidance
website/docs/packs/index.md
The documentation describes token lookup options and advises using CLI authentication or -Token outside pipelines. It states that telemetry reports test totals unless disabled, without identifying the pack, and that Maester is not told which local-folder pack is installed.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Possibly related issues

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: f-bader, claude

Merge Risk: Minimal · up to 240b1

This is a text-only documentation update clarifying private-pack authentication and telemetry wording. It does not change runtime behavior and has no identified merge risk.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title clearly identifies both main changes: removing the duplicated Private packs section and correcting the telemetry documentation.
Description check Passed The description clearly explains the documentation changes, their scope, the telemetry verification, and the fact that the page was not built. It does not reproduce the template headings or checklist,…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description clearly explains the documentation changes, their scope, the telemetry verification, and the fact that the page was not built. It does not reproduce the template headings or checklist, but it provides the required information and is mostly complete.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 77f3bdc and 240b16d.

Files selected for processing: 1

  • website/docs/packs/index.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@merill
merill merged commit 02a220b into main Nov 11, 2026
13 checks passed
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.

1 participant