Skip to content

content: Launch post — Keep Docs Current as a Pull Request Evolves - #899

Open
frances720 wants to merge 2 commits into
mainfrom
articles/2026-08-24-github-pr-review-on-push
Open

content: Launch post — Keep Docs Current as a Pull Request Evolves#899
frances720 wants to merge 2 commits into
mainfrom
articles/2026-08-24-github-pr-review-on-push

Conversation

@frances720

Copy link
Copy Markdown
Contributor

Feature

A new opt-in trigger_on: [updated] mode re-reviews an open GitHub PR on every push. Documentation suggestions stay current as code changes during review, not just at open, approval, or merge.

Entries considered this run

Window: 2026-08-17 → 2026-08-24 (7 days). 6 commits, 5 changelog entries considered, 3 qualified (this is one of three PRs from this run — see also #897 for MCP triggers and #898 for Jira triggers).

# Entry Decision Reason
1 Start documentation tasks from your editor over MCP — Connect Promptless to Claude Code or Cursor via MCP; OAuth authorization, no API key; four tools QUALIFIES New trigger/integration type enabling editor-based doc task submission; covered in PR #897
2 Start a Promptless session from a Jira ticket — Four paths to start a session (assign, label, @mention, configured trigger); Promptless replies on the ticket QUALIFIES New trigger type (Jira) unlocking documentation workflows for Jira-using teams; covered in PR #898
3 Re-review GitHub PRs as new commits land — New trigger_on: [updated] value turns Promptless into a review bot that re-reviews an open PR on every push QUALIFIES New trigger mode enabling continuous documentation review as code evolves; covered in this PR
4 Triage every screenshot in one place — New Screenshot Updates dashboard tab gathers screenshots on open suggestions into a gallery grouped by doc collection SKIP UI reorganization; doesn't materially change a core workflow, adds a new gallery view for existing content
5 Microsoft Teams channel access and channel picker — Admin can grant read access via Graph consent; channel picker replaces raw conversation ID paste SKIP Expanded configuration on existing capability; doesn't open a materially new use case; adjacent to existing Teams posts and open PR #837
(6) Split documentation by product (df9c558) SKIP Doc restructuring only (URL path updates); no new changelog entry added

6 commits in window. 5 entries considered, 3 qualified.

Covered entry (full text)

Re-review GitHub PRs as new commits land: A github_pr trigger now accepts a new opt-in trigger_on value, updated, that turns Promptless into a review bot for an open pull request: whenever new commits are pushed, it re-reviews the PR and keeps its suggestions current as the code evolves. It's inert by default and requires an explicit repos list to enable (repos: all isn't allowed), and it applies to GitHub only. See Trigger modes.

Source: commit ffb47b1 (2026-08-19).

PR(s) researched

  • Promptless/promptless#4449 — opt-in github_pr updated trigger (review on push)

File

src/content/blog/product-updates/github-pr-review-on-push.mdx

AI-generated draft — needs human review before publishing.


Generated by Claude Code

@vercel

vercel Bot commented Aug 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
promptless-docs Ready Ready Preview Aug 24, 2026 2:23pm

Request Review

@promptless promptless Bot 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.

Thanks Frances — reviewing this launch post for the new opt-in github_pr re-review-on-push mode as a documentation-specialist pass (correctness against source + doc quality/style). The verdict is Comment, not Approve: the post is accurate on all its load-bearing constraints and matches our blog conventions, but two things are worth a quick tweak before it ships.

Correctness against source — verified, all confirmed:

  • New opt-in trigger_on: [updated] re-reviews an open PR on every push — ✅ matches the Trigger modes docs and the August 2026 changelog.
  • Off/inert by default; existing triggers unaffected — ✅.
  • Explicit repos list required, repos: all disallowed for an updated clause — ✅ (and correctly scoped per match clause).
  • GitHub-only, no GitLab/Bitbucket equivalent — ✅.
  • Draft PRs skipped, runs alongside the other modes — ✅.
  • The YAML examples match the canonical config shape in github-prs.mdx, and the /docs/for-docs/connect/triggers/github-prs#trigger-modes link + #trigger-modes anchor both resolve — ✅.

Doc quality & style: Voice, structure (problem → what it does → who benefits → how to use), and frontmatter all fit the product-updates blog convention. Two findings below — one style-guide convention, one minor precision fix. Neither blocks; both are quick.

Nice, tightly-scoped post overall.

import BlogNewsletterCTA from '@components/site/BlogNewsletterCTA.astro';
import BlogRequestDemo from '@components/site/BlogRequestDemo.astro';

A `github_pr` trigger now supports `trigger_on: [updated]`, which re-runs Promptless on an open pull request each time new commits are pushed. The documentation suggestion stays current as the code changes, not just at the moment the PR opens.

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.

Style-guide convention: in prose we refer to these as a "GitHub PR trigger," not the bare code identifier github_pr (Manny, PR #781 review — reserve github_pr for places where a literal config/YAML value is genuinely required). The trigger_type: github_pr inside the YAML blocks below is correct and should stay; it's just this opening prose sentence. Suggested rewording: "A GitHub PR trigger now supports a new trigger_on value, updated, which re-runs Promptless…" — that keeps updated as the literal config value while dropping the bare identifier from prose.

- **An explicit `repos` list is required.** The `updated` mode can't use `repos: all`. A push-on-every-PR to every repo would generate disproportionate volume, so the mode requires naming repos explicitly.
- **Draft PRs are skipped**, same as the other modes.
- **Only GitHub is supported.** GitLab and Bitbucket don't have an equivalent.
- **Each push produces a full re-review pass.** A PR with 20 incremental commits yields 20 passes. Scope it with `trigger_directories` if you want to limit which pushes actually trigger a run.

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.

Minor precision: a re-review pass fires per push, not per commit. The source docs phrase it as "Every push produces a re-review pass, so a PR with many incremental commits yields many passes" — several commits pushed together count as one pass, so "20 incremental commits yields 20 passes" only holds if each commit is pushed separately. Suggest matching the docs' framing, e.g. "Each push produces a full re-review pass, so a PR pushed to many times yields many passes."

- Use 'GitHub PR trigger' in prose instead of bare github_pr identifier
- Correct 'commits yields passes' to 'pushes yields passes': several
  commits pushed together count as one re-review pass, not one per commit

Addresses bot review comments on PR #899.
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