Skip to content

[TEST] Preview link comment shows a stale commit after a force-push #9248

New issue
New issue
Closed as not planned
Closed as not planned
[TEST] Preview link comment shows a stale commit after a force-push#9248
Labels
needs-teamIssues pending triage by the Docs TeamtriagedTriage has been run on this issue

Description

@theletterf
theletterf
opened on Nov 6, 2026

Test issue for the gh-aw v1.0.1 rollout (elastic/docs-actions#447). Safe to ignore; it will be closed shortly.

What needs to change

The docs preview comment on a pull request keeps showing the commit SHA from before a force-push, so reviewers open a preview that does not match the branch head.

Why this matters

Two reviewers last week commented on text that was already rewritten, because the comment still linked the old build.

What done looks like

The preview comment is updated with the new head SHA after every force-push, and a short note in the docs-builder contributor guide explains the behavior.

Activity

  1. github-actions
    added
    needs-teamIssues pending triage by the Docs Team
    on Nov 6, 2026

  2. github-actions commented on Nov 6, 2026

    @github-actions
    github-actionsBot
    on Nov 6, 2026 – with GitHub Actions
    Contributor

    Elastic Docs AI Menu

    Check one box to run an AI workflow for this issue.

    • Scope the docs work (docs-scope). Status: not started.

    Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

  3. github-actions
    added
    triagedTriage has been run on this issue
    on Nov 6, 2026

  4. theletterf commented on Nov 6, 2026

    @theletterf
    theletterf
    on Nov 6, 2026
    MemberAuthor

    /scope

  5. github-actions commented on Nov 6, 2026

    @github-actions
    github-actionsBot
    on Nov 6, 2026 – with GitHub Actions
    Contributor

    ✅ ScopeBot finished. https://github.com/elastic/docs-content/actions/runs/42200713144

    Generated from Gh Aw Issue Scope

  6. github-actions commented on Nov 6, 2026

    @github-actions
    github-actionsBot
    on Nov 6, 2026 – with GitHub Actions
    Contributor

    🟢 ScopeBot Results: Full assessment

    Summary

    The issue asks for two outcomes: refresh the pull-request docs preview comment to the new head SHA after every force-push, and document that behavior for contributors. The published Contribute locally guide covers docs-builder setup and local previews but has no guidance for pull-request preview comments or force-pushes. The referenced elastic/docs-actions#447 is a merged gh-aw v1.0.1 version update; its description and changed files do not show an implementation of this preview-comment behavior.

    Request accuracy

    Unsupported by linked changes: the referenced PR updates workflow tooling and does not address the stale preview comment or add contributor documentation.

    Recommended docs targets

    Page URL Action Confidence Why this page?
    Contribute locally https://www.elastic.co/docs/contribute-docs/locally Add section to existing page Medium This is the existing contributor guide for installing and using docs-builder, with sections for building and previewing docs locally. Add the short pull-request preview note near Push your changes or Preview locally if this repository owns the requested guidance.

    How to tackle this

    1. Confirm whether the canonical contributor guidance belongs in docs-content/contribute-docs/locally.md or in the separate docs-builder repository; the published docs page is the smallest viable target in this repository.
    2. After the preview-comment implementation is available, add a short note to Contribute locally describing that the PR preview comment follows the current branch head and is refreshed after a force-push.
    3. Link the note to the relevant preview workflow or troubleshooting guidance if one exists, then run the docs build and link checks.

    Scope boundary

    No product documentation, release-note, or unrelated contributor-guide changes appear necessary; the stale-comment implementation itself belongs in the workflow/action codebase rather than this content repository.

    Questions to go deeper

    • Should the contributor-facing note be maintained in this repository’s Contribute locally page, or in the docs-builder repository’s guide?
    • Is a separate implementation change planned for the preview workflow/action, or should this issue be documentation-only after that fix lands?
    • What exact preview-comment wording or link should the documentation describe so it remains accurate when the workflow changes?

    This scope reflects the issue as of this run. Comment /scope to run it again after the issue changes.

    Generated from Gh Aw Issue Scope · ◷

    Scope requested by @theletterf. Was it helpful? When the work closes, add the label ai-scope:helpful or ai-scope:unhelpful to this issue.

  7. theletterf commented on Nov 6, 2026

    @theletterf
    theletterf
    on Nov 6, 2026
    MemberAuthor

    Test issue for the gh-aw v1.0.1 rollout (elastic/docs-actions#447, merged). Closing.

  8. theletterf
    closed this as not plannedon Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs-teamIssues pending triage by the Docs TeamtriagedTriage has been run on this issue

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions