Skip to content

docs: say that labelled and output-sourced options need Runbooks 0.31 - #479

Open
odgrim wants to merge 2 commits into
mainfrom
docs/options-version-note
Open

odgrim wants to merge 2 commits into
mainfrom
docs/options-version-note

Conversation

@odgrim

@odgrim odgrim commented Nov 20, 2026 •

Copy link
Copy Markdown
Collaborator

Why

A user on 0.30.0 followed the options from a block's output docs and got:

TypeError: (variable.options ?? []).map is not a function
    at EnumSelect

The feature (#466) merged after v0.30.0 was tagged. The docs are published from main, so they described it before any release had it. 0.30.0 passes an options string straight to the dropdown, which throws. On main, the user's runbook works: the options come from the output, and a value that isn't one of them is refused.

What

In authoring/boilerplate.mdx:

This assumes the next release is 0.31.0. If it ends up with another number, these two lines change with it.

The output-options demo runbook still has no runbooks: requirement on purpose. package.json only changes at release time, so dev builds and CI on main report 0.30.0 and would refuse a >= 0.31 requirement.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that output-backed options require Runbooks 0.31 or later. Earlier versions cannot display output-backed dropdowns and show multi-selects as plain lists.

Runbooks 0.30 passes an `options` string straight to the dropdown, which
throws "(variable.options ?? []).map is not a function". The docs are
published from main, so they described the feature before any release had
it. Name the version, and point to the front-matter requirement that makes
an earlier version refuse the runbook instead of crashing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@odgrim
odgrim requested a review from yhakbar as a code owner November 20, 2026 18:13
@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
runbooks Ready Ready Preview Nov 20, 2026 6:18pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Explain Change →

Warning

Review limit reached

  • Run on-demand review

This review includes 1 billable file and costs up to $0.25.

Or wait 53 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 950470fb-716c-4b3b-a047-fde5503c3932
Commits

Reviewing files that changed from the base of the PR and between b44c5ed and c3478cc.

Files selected for processing: 1

  • docs/src/content/docs/authoring/boilerplate.mdx

No actionable comments were generated in the recent review.

Walkthrough

The authoring guide imports Aside and adds a note about Runbooks version requirements for options sourced from block outputs.

Changes

Output-backed option documentation

Layer / File(s) Summary
Document output-backed option requirements
docs/src/content/docs/authoring/boilerplate.mdx
The page adds a note that output-backed options require Runbooks 0.31 or later. It describes how earlier versions display output-backed dropdowns and multi-selects, and links to front matter for setting a minimum version.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: zachgoldberg

Merge Risk: Minimal · previous review b44c5

This change only updates documentation to say output-sourced and labelled options need Runbooks 0.31 or later. It does not change runtime behavior and is low risk to merge. The release number in the note needs to match the actual next release.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: the docs now say that output-sourced and labelled options need Runbooks 0.31. The raw summary and objectives both describe a docs-only note on the version requirement,…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title names the main change: the docs now say that output-sourced and labelled options need Runbooks 0.31. The raw summary and objectives both describe a docs-only note on the version requirement, so the title matches the changeset.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
Fix failing CI checks

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A note appears beside the options guide
Aside helps it find a place to reside
Output-backed choices need the right version
Older displays may take a different diversion
Front matter points the way to set the floor

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3d9b0cee-e015-4e98-abe4-f4e3578a498d
Commits

Reviewing files that changed from the base of the PR and between 9cd7424 and b44c5ed.

Files selected for processing: 1

  • docs/src/content/docs/authoring/boilerplate.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — c3478cce Deployed Nov 20, 2026 by vercel[bot]
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.

1 participant