Update docs-impact workflow to keep stale comment instead of deleting (#35940)

* Update docs-impact workflow to keep stale comment instead of deleting

When a re-run of the docs impact analysis determines that documentation
updates are no longer needed, the previous bot comment was deleted while
the Docs/Needed label was kept. This left the label without context.

Instead of deleting the comment, update it to explain that a previous
analysis had flagged the PR but the latest run found no docs impact.
This preserves the audit trail and gives maintainers context to decide
whether to remove the label.

Made-with: Cursor

* Update .github/workflows/docs-impact-review.yml

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
Eva Sarafianou
2026-04-07 13:20:03 +03:00
committed by GitHub
co-authored by coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
parent c17bd2ad9b
commit 375f4d5a1c
+5 -1
View File
@@ -274,10 +274,14 @@ jobs:
});
}
} else if (existing) {
await github.rest.issues.deleteComment({
const staleBody = `${marker}\n<details>\n<summary>Documentation Impact Analysis — no longer needed</summary>\n\n` +
`A previous automated documentation impact comment exists, but the latest analysis determined that no documentation changes are needed.\n\n` +
`The \`Docs/Needed\` label may still be present from the earlier analysis. A maintainer can remove it after confirming no docs updates are required.\n</details>`;
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body: staleBody,
});
}