Skip to content

doc-review: replace @github-copilot comment with GitHub Check Run for visual review#6974

Merged
jstirnaman merged 2 commits intocopilot/improve-review-status-signalsfrom
copilot/revert-merge-pr-6985
Mar 22, 2026
Merged

doc-review: replace @github-copilot comment with GitHub Check Run for visual review#6974
jstirnaman merged 2 commits intocopilot/improve-review-status-signalsfrom
copilot/revert-merge-pr-6985

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 22, 2026

The copilot-visual-review job posted a PR comment mentioning @github-copilot, which never invokes Copilot Vision and produces no entry in the Checks tab—a silent no-op that implied review was happening when it wasn't.

Changes

doc-review.yml — Job 3 (copilot-visual-review)

  • Drop pull-requests: write; add checks: write
  • Create an in_progress check run via checks.create at job start (immediately visible in Checks tab)
  • On preview available: complete with conclusion: neutral, output contains linked page list + full checklist from .github/prompts/copilot-visual-review.md
  • On timeout: complete with conclusion: neutral and re-run instructions
  • Remove all PR comment logic (including the @github-copilot mention)

doc-review.yml — Job 4 (report-skipped)

  • Drop pull-requests: write; add checks: write
  • Replace PR comment with checks.create at conclusion: skipped, explaining why no pages were reviewed

DOC-REVIEW-PIPELINE-PLAN.md / LABEL_GUIDE.md

  • Update section 2.4, 2.6, Q1 decision record, ASCII diagram, and pipeline step descriptions to reflect check-run-based approach
# Before: job posted a PR comment (no Checks entry, no Copilot action triggered)
- name: Post visual review request
  uses: actions/github-script@...
  with:
    script: |
      # ... upserts comment body containing @github-copilot mention

# After: creates an explicit Check Run visible in the Checks tab
- name: Create in-progress check run
  id: create-check
  uses: actions/github-script@...
  with:
    script: |
      const { data: check } = await github.rest.checks.create({
        name: 'Visual Review',
        head_sha: process.env.HEAD_SHA,
        status: 'in_progress',
        ...
      });

- name: Complete check run — preview available
  uses: actions/github-script@...
  with:
    script: |
      await github.rest.checks.update({
        check_run_id: checkRunId,
        status: 'completed',
        conclusion: 'neutral',   // awaiting human review
        output: { title, summary, text: pageList + checklist },
      });
Original prompt

Pull request: #6938

revert the merge of this PR from #6985 and reopen this PR for the additional tasks:

Here’s what the workflow in PR #6895 is doing and why you see the prompt but no Copilot action or Check:

  1. Why the visual review prompt appears but Copilot doesn’t run
  • Job 3 (copilot-visual-review) only posts a templated comment tagging @github-copilot after it finds preview URLs and confirms the preview site is live. It never invokes any Copilot API or agent run; it just writes a comment with the checklist. citecall_iAf9D7LOH37rNqKxc80uPSM8
  • Unlike the code-review job (which requests the copilot-pull-request-reviewer as a reviewer), there is no equivalent trigger for a “visual review” agent. Mentions alone don’t cause Copilot Vision to execute, so Copilot doesn’t perform any work beyond the comment being posted. citecall_iAf9D7LOH37rNqKxc80uPSM8
  1. Why it isn’t listed under Checks
  • The workflow doesn’t create a separate check run for visual review. The job uses actions/github-script to post/update an issue comment; it doesn’t register a GitHub Check, so nothing new appears in the Checks tab. citecall_iAf9D7LOH37rNqKxc80uPSM8
  • Only jobs that produce check runs (e.g., test/build steps) or the Copilot code-review ruleset show up as Checks. The visual-review comment is outside that mechanism, so it lives solely as a PR comment.

Redesign the workflow.
To perform the visual review and show status in Checks, you’d need a step that calls a Copilot Vision-capable action or service (or a GitHub App that reports a check run) instead of just posting the comment.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…heck Run

- Replace PR comment mentioning @github-copilot (which never triggered
  Copilot Vision) with GitHub Check Run via checks.create/checks.update
- Add checks: write permission to Jobs 3 and 4; downgrade pull-requests
  to read-only (no more PR comment writes needed)
- Job 3 (copilot-visual-review): create in-progress check, wait for
  preview, complete as neutral with URLs+checklist or timeout message
- Job 4 (report-skipped): create a skipped check run instead of a comment
- Update DOC-REVIEW-PIPELINE-PLAN.md and LABEL_GUIDE.md to match

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/influxdata/docs-v2/sessions/ef35b1d0-87cf-4b4f-92df-fff980a423c6
Copilot AI changed the title [WIP] Revert merge of PR #6985 and reopen for additional tasks doc-review: replace @github-copilot comment with GitHub Check Run for visual review Mar 22, 2026
Copilot AI requested a review from jstirnaman March 22, 2026 12:42
@jstirnaman jstirnaman marked this pull request as ready for review March 22, 2026 13:38
@jstirnaman jstirnaman requested a review from a team as a code owner March 22, 2026 13:38
@jstirnaman jstirnaman requested review from sanderson and removed request for a team March 22, 2026 13:38
@jstirnaman jstirnaman merged commit 2ef9468 into copilot/improve-review-status-signals Mar 22, 2026
1 check passed
jstirnaman added a commit that referenced this pull request Mar 26, 2026
… visual review (#6974) (#6975)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* doc-review: replace @github-copilot comment with GitHub Check Run for visual review (#6974)

* Initial plan

* Redesign visual review: replace @github-copilot comment with GitHub Check Run

- Replace PR comment mentioning @github-copilot (which never triggered
  Copilot Vision) with GitHub Check Run via checks.create/checks.update
- Add checks: write permission to Jobs 3 and 4; downgrade pull-requests
  to read-only (no more PR comment writes needed)
- Job 3 (copilot-visual-review): create in-progress check, wait for
  preview, complete as neutral with URLs+checklist or timeout message
- Job 4 (report-skipped): create a skipped check run instead of a comment
- Update DOC-REVIEW-PIPELINE-PLAN.md and LABEL_GUIDE.md to match

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/influxdata/docs-v2/sessions/ef35b1d0-87cf-4b4f-92df-fff980a423c6

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* resolve conflicts: merge copilot/fix-broken-docker-link into copilot/resolve-conflicts (#6976)

* Initial plan

* Add aliases to fix broken Docker Hub links to serve documentation

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix(influxdb3): correct broken links causing 404s (#6958)

- Fix Power BI links in visualization-tools.md for cloud-dedicated,
  cloud-serverless, and clustered to use new visualize-data/ path
  instead of old process-data/visualize/ path
- Fix influxctl cluster list link in cloud-dedicated/admin/clusters/list.md
  to include missing cluster/ path segment

https://claude.ai/code/session_01SV14CdHN4GGVuATt9n7STn

Co-authored-by: Claude <noreply@anthropic.com>

* fix(influxdb3): backfill missing product URLs in localStorage (#6961)

* fix(influxdb3): backfill missing product URLs in localStorage

Returning visitors with stale localStorage (created before core/enterprise
products were added) had undefined URL values for new products. The
updateUrls() function then replaced Hugo-rendered hostnames like
localhost:8181 with the string "undefined" in api-endpoint blocks.

Fix by merging DEFAULT_STORAGE_URLS as fallbacks when reading from
localStorage, so new product keys are always present.

closes #6960

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

* test(influxdb3): add Cypress tests for localStorage URL backfill

Adds 2 E2E tests for the fix in #6960:

1. Stale localStorage (missing `core` key) should not cause "undefined"
   to appear in api-endpoint or code blocks on the plugins page.
2. Fresh localStorage should be initialized with all expected product
   URL keys (oss, cloud, core, enterprise, serverless, dedicated, clustered).

Run with:
  node cypress/support/run-e2e-specs.js --spec "cypress/e2e/influxdb-url.cy.js" --no-mapping

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

---------

Co-authored-by: Claude <noreply@anthropic.com>

* Remove `>` CLI prompts from runnable code blocks in InfluxQL/Flux/MongoDB docs (#6948)

* Initial plan

* fix(docs): remove > prompt from runnable code blocks

Remove leading `>` CLI prompt characters from code blocks that are meant
to be executed by users. Only keep `>` in code blocks that demonstrate
console output (showing both the command at the prompt AND the result output).

Changes affect 34 files across InfluxDB v1, Enterprise InfluxDB, shared
influxql-v3 reference, and Telegraf content:
- InfluxQL queries and management commands (sql/bash/no-lang blocks)
- Flux REPL examples (js blocks)
- MongoDB shell commands (shell blocks)

Preserved (unchanged):
- Console session blocks showing command + output (Type B: mixed > and non-> lines)
- Telegraf metric output blocks (text language with > measurement,tags format)
- diff blocks with < and > diff markers

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Apply suggestions from code review

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Apply suggestions from code review

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Update content/enterprise_influxdb/v1/query_language/continuous_queries.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Add agentic workflow daily-repo-status (#6963)

* PR workflow: Improve review status signals and reduce noise (#6938)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Initial plan

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Initial plan (#6977)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jstirnaman added a commit that referenced this pull request Mar 26, 2026
…#6895)

* Initial plan

* Add aliases to fix broken Docker Hub links to serve documentation

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* PR workflow: Improve review status signals and reduce noise (#6938)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* doc-review: replace @github-copilot comment with GitHub Check Run for visual review (#6974) (#6975)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* doc-review: replace @github-copilot comment with GitHub Check Run for visual review (#6974)

* Initial plan

* Redesign visual review: replace @github-copilot comment with GitHub Check Run

- Replace PR comment mentioning @github-copilot (which never triggered
  Copilot Vision) with GitHub Check Run via checks.create/checks.update
- Add checks: write permission to Jobs 3 and 4; downgrade pull-requests
  to read-only (no more PR comment writes needed)
- Job 3 (copilot-visual-review): create in-progress check, wait for
  preview, complete as neutral with URLs+checklist or timeout message
- Job 4 (report-skipped): create a skipped check run instead of a comment
- Update DOC-REVIEW-PIPELINE-PLAN.md and LABEL_GUIDE.md to match

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/influxdata/docs-v2/sessions/ef35b1d0-87cf-4b4f-92df-fff980a423c6

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* resolve conflicts: merge copilot/fix-broken-docker-link into copilot/resolve-conflicts (#6976)

* Initial plan

* Add aliases to fix broken Docker Hub links to serve documentation

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix(influxdb3): correct broken links causing 404s (#6958)

- Fix Power BI links in visualization-tools.md for cloud-dedicated,
  cloud-serverless, and clustered to use new visualize-data/ path
  instead of old process-data/visualize/ path
- Fix influxctl cluster list link in cloud-dedicated/admin/clusters/list.md
  to include missing cluster/ path segment

https://claude.ai/code/session_01SV14CdHN4GGVuATt9n7STn

Co-authored-by: Claude <noreply@anthropic.com>

* fix(influxdb3): backfill missing product URLs in localStorage (#6961)

* fix(influxdb3): backfill missing product URLs in localStorage

Returning visitors with stale localStorage (created before core/enterprise
products were added) had undefined URL values for new products. The
updateUrls() function then replaced Hugo-rendered hostnames like
localhost:8181 with the string "undefined" in api-endpoint blocks.

Fix by merging DEFAULT_STORAGE_URLS as fallbacks when reading from
localStorage, so new product keys are always present.

closes #6960

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

* test(influxdb3): add Cypress tests for localStorage URL backfill

Adds 2 E2E tests for the fix in #6960:

1. Stale localStorage (missing `core` key) should not cause "undefined"
   to appear in api-endpoint or code blocks on the plugins page.
2. Fresh localStorage should be initialized with all expected product
   URL keys (oss, cloud, core, enterprise, serverless, dedicated, clustered).

Run with:
  node cypress/support/run-e2e-specs.js --spec "cypress/e2e/influxdb-url.cy.js" --no-mapping

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

---------

Co-authored-by: Claude <noreply@anthropic.com>

* Remove `>` CLI prompts from runnable code blocks in InfluxQL/Flux/MongoDB docs (#6948)

* Initial plan

* fix(docs): remove > prompt from runnable code blocks

Remove leading `>` CLI prompt characters from code blocks that are meant
to be executed by users. Only keep `>` in code blocks that demonstrate
console output (showing both the command at the prompt AND the result output).

Changes affect 34 files across InfluxDB v1, Enterprise InfluxDB, shared
influxql-v3 reference, and Telegraf content:
- InfluxQL queries and management commands (sql/bash/no-lang blocks)
- Flux REPL examples (js blocks)
- MongoDB shell commands (shell blocks)

Preserved (unchanged):
- Console session blocks showing command + output (Type B: mixed > and non-> lines)
- Telegraf metric output blocks (text language with > measurement,tags format)
- diff blocks with < and > diff markers

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Apply suggestions from code review

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Apply suggestions from code review

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Update content/enterprise_influxdb/v1/query_language/continuous_queries.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Add agentic workflow daily-repo-status (#6963)

* PR workflow: Improve review status signals and reduce noise (#6938)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Initial plan

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Initial plan (#6977)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Move Docs review workflow plan to https://github.com/orgs/influxdata/projects/107?pane=issue&itemId=169574788

* Apply suggestions from code review

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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