Skip to content

docs: require upgrade-guide review when releasing or backporting - #2986

Merged
killme2008 merged 1 commit into
mainfrom
docs/upgrade-release-review
Nov 5, 2026
Merged

killme2008 merged 1 commit into
mainfrom
docs/upgrade-release-review

Conversation

@evenyag

@evenyag evenyag commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

What changed

Versioning or backporting docs can leave shipped changes labeled as Nightly-only, or copy unreleased changes into a stable upgrade guide. Add a release review checklist that requires verifying each entry against the target GreptimeDB release and updating both Nightly and versioned English/Chinese guides.

Add the reminder to AGENTS.md, the regular PR template, and the generated major/minor and patch version-bump PR descriptions. Require the first applicable patch version for backports and a recorded review outcome. Release inclusion remains a manual, evidence-based decision.

Scope

  • Documentation versions: repository contribution and release workflow guidance
  • Languages: English maintainer instructions; checklist requires English/Chinese user guides to stay aligned
  • Workflow changes affect PR body text only; no release execution changes.

Verification

  • pnpm test: 59 tests passed.
  • pnpm typecheck: blocked by missing local type definitions for node and @docusaurus/theme-classic; the unchanged main checkout fails with the same errors. No TypeScript or dependency files were changed.
  • Parsed both modified workflows as YAML and compared them with the originals: only generated PR bodies changed, each containing four checklist items and the target-version expression.
  • git diff --check and complete diff review passed.
  • No site pages, routes, navigation, generated content, or dependencies changed, so site builds and link checks were not rerun.

Checklist

  • I verified the content against the applicable GreptimeDB version. (Release workflow guidance; no new product behavior claims.)
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors. (No site links or anchors changed.)
  • I updated navigation when the document structure changed. (Not applicable.)
  • Release-specific upgrade review: not applicable to this maintainer-guidance PR.

Signed-off-by: evenyag <realevenyag@gmail.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5488b0d
Status: ✅  Deploy successful!
Preview URL: https://dc9965e5.greptime-docs.pages.dev
Branch Preview URL: https://docs-upgrade-release-review.greptime-docs.pages.dev

View logs

@fengjiachun fengjiachun 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.

LGTM

@killme2008
killme2008 merged commit 8084ef0 into main Nov 5, 2026
7 checks passed
@killme2008
killme2008 deleted the docs/upgrade-release-review branch November 5, 2026 04:52
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.

3 participants