Skip to content

Remove gh auth token doc content anticipated by #207's PR - #211

Merged
shouze merged 1 commit into
mainfrom
fix/remove-anticipated-gh-cli-docs
Sep 19, 2026
Merged

shouze merged 1 commit into
mainfrom
fix/remove-anticipated-gh-cli-docs

Conversation

@shouze

@shouze shouze commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

PR #209 (closing #207, GCS_DEFAULT_ORG) prematurely documented the GITHUB_TOKENgh auth token fallback that belongs to #208 and wasn't implemented yet at merge time. This reverts those specific doc mentions from README.md, docs/getting-started/index.md, docs/getting-started/first-search.md and docs/reference/environment.md, keeping only the GCS_DEFAULT_ORG content that #207 actually delivered.

PR #210 (closing #208) reintroduces this documentation alongside the real implementation, so it lives only where it belongs.

How did you verify your code works?

  • bun test (1016 passing), bun run lint, bun run format:check, bun run knip all green.
  • bun run docs:build succeeds (no dead links).

PR #209 (closing #207, GCS_DEFAULT_ORG) prematurely documented the
GITHUB_TOKEN -> gh auth token fallback that belongs to #208 and hadn't been
implemented yet at merge time. Revert those specific mentions from
README.md, docs/getting-started/index.md, docs/getting-started/first-search.md
and docs/reference/environment.md, keeping only the GCS_DEFAULT_ORG content.
PR #210 (closing #208) reintroduces this documentation alongside the actual
implementation.
Copilot AI lite review requested due to automatic review settings September 19, 2026 11:26
@github-actions

Copy link
Copy Markdown
Contributor

Coverage after merging fix/remove-anticipated-gh-cli-docs into main will be

96.86%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
src
   aggregate.ts100%100%100%100%
   api-utils.ts93.20%100%93.75%93.13%101–103, 65, 73, 86–87, 91–92
   api.ts94.74%100%100%94.07%340–344, 405, 422, 63–69
   cache.ts94.67%100%100%94.29%139–141, 39
   completions.ts99.46%100%100%99.41%282
   group.ts98.92%100%98.33%99.03%263–265, 525, 531, 864
   output.ts99.38%100%95.83%99.66%88
   regex.ts99.42%100%100%99.38%360
   render.ts90.99%100%88.24%91.09%177, 201–206, 208–210, 212–213, 234, 427–428, 528–532, 562–569, 571–579, 581–584
   scroll-cooldown.ts100%100%100%100%
   style.ts100%100%100%100%
   upgrade.ts88.38%100%94.44%87.89%128, 131, 133, 153, 167–168, 188–195, 198–204, 209, 214, 250–253
src/render
   filter-match.ts97.44%100%92.31%100%
   filter.ts100%100%100%100%
   highlight.ts96.63%100%90.40%99.31%284–285
   layout-constants.ts100%100%100%100%
   mouse-hit.ts100%100%100%100%
   mouse.ts100%100%100%100%
   rows.ts99.42%100%100%99.38%239
   selection.ts100%100%100%100%
   summary.ts100%100%100%100%
   team-pick.ts100%100%100%100%
   terminal.ts100%100%100%100%

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.

Copilot review overview

🟢 Approval recommended

The documentation changes are scoped, consistent with the current implementation, and preserve the valid GCS_DEFAULT_ORG content.

Review effort: Lite
Findings: None

What changed in this PR

Removes premature gh auth token fallback documentation so the docs match the current implementation, while preserving the delivered GCS_DEFAULT_ORG guidance.

Changes:

  • Removes fallback notes from README and getting-started documentation.
  • Removes the fallback section from environment variable reference.
  • Restores the prerequisite wording requiring GITHUB_TOKEN.
File Description
README.md Removes premature fallback tip.
docs/​reference/​environment.md Removes fallback documentation.
docs/​getting-started/​index.md Removes GitHub CLI setup tip.
docs/​getting-started/​first-search.md Restores the token prerequisite.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

🔦 Lighthouse Report

Page ⚡ Perf ♿ A11y 🛡️ BP 🔍 SEO Report
/github-code-search/getting-started/ 🟢 100 (≥96) 🟢 100 (≥99) 🟢 100 (≥99) 🟢 100 (≥99) 🔗 view
/github-code-search/ 🟢 98 (≥96) 🟢 100 (≥99) 🟢 100 (≥99) 🟢 100 (≥99) 🔗 view

Thresholds: Perf ≥ 96 · A11y ≥ 99 · BP ≥ 99 · SEO ≥ 99
commit 7f90543 · full workflow run

@shouze
shouze merged commit aa750b8 into main Sep 19, 2026
9 checks passed
@shouze
shouze deleted the fix/remove-anticipated-gh-cli-docs branch September 19, 2026 11:29
shouze added a commit that referenced this pull request Sep 19, 2026
…n rebase

These were silently reverted during the rebase onto post-#211 main (never
part of this PR's own diff before), since #211 removed the same wording
that was accidentally shared with #209. Re-add them here so they're
properly attributed to this PR.
shouze added a commit that referenced this pull request Sep 19, 2026
- Restore the exact original 'Error: GITHUB_TOKEN environment variable is
  not set.' message (unchanged acceptance-criteria contract) instead of
  replacing it; add the gh CLI hint as a separate dim line.
- environment.md: clarify the GITHUB_TOKEN footnote applies to the search
  commands, and that upgrade never requires a token (uses one only
  opportunistically for rate limits).
- docs/usage/upgrade.md: document the gh auth token fallback for upgrade.
- Re-add the 'Already using the GitHub CLI?' tip to
  docs/getting-started/index.md, silently dropped by an earlier rebase
  onto main after #211 merged — this is what the prerequisite sentence's
  'see below' was supposed to point to.
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.

2 participants