Skip to content

CI: Fix PR description tests#35200

Merged
Sidnioulz merged 3 commits into
nextfrom
sidnioulz/fix-pr-description-test
Jun 17, 2026
Merged

CI: Fix PR description tests#35200
Sidnioulz merged 3 commits into
nextfrom
sidnioulz/fix-pr-description-test

Conversation

@Sidnioulz

@Sidnioulz Sidnioulz commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Fixes a recent regression I introduced in a test suite used for CI tools: https://app.circleci.com/pipelines/github/storybookjs/storybook/125284/workflows/92325e66-19b9-4913-a8d1-7877d6678454/jobs/1622501

Manual testing

Unit tests for PR descriptions should pass again.

Summary by CodeRabbit

  • Tests

    • Updated PR description generation test snapshots to match the new checklist/checkbox formatting.
  • Changes

    • PR descriptions now show only “Direct commit” as an unchecked todo checkbox, while other changelist sections (Bug, Feature Request, Documentation, Missing Label) render as plain bullet points for clearer readability.
  • Documentation

    • Added a JSDoc @param annotation for the release checklist helper’s body argument.

@Sidnioulz Sidnioulz requested a review from a team June 17, 2026 17:54
@Sidnioulz Sidnioulz self-assigned this Jun 17, 2026
Copilot AI review requested due to automatic review settings June 17, 2026 17:54
@Sidnioulz Sidnioulz added build Internal-facing build tooling & test updates ci:normal Run our default set of CI jobs (choose this for most PRs). qa:skip Pull Requests that do not need any QA. labels Jun 17, 2026

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Sidnioulz Sidnioulz changed the title Fix PR description tests CI: Fix PR description tests Jun 17, 2026
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4ad5f950-2391-487d-9c8b-6ac28a778d40

📥 Commits

Reviewing files that changed from the base of the PR and between 755e986 and 44d21f1.

📒 Files selected for processing (1)
  • scripts/dangerfile.js
✅ Files skipped from review due to trivial changes (1)
  • scripts/dangerfile.js

📝 Walkthrough

Walkthrough

Two inline snapshots in the mapToChangelist test are updated so that only the "Direct commit" entry renders as an unchecked checkbox todo (- [ ]), while Bug, Feature Request, Documentation, and Missing Label bullets render as plain list items. This applies to both the patch-PR and prerelease-PR test cases. Additionally, a missing JSDoc @param {string} body annotation is added to the checkReleaseChecklist function in scripts/dangerfile.js.

Changes

Release Checklist Snapshot Formatting and Documentation

Layer / File(s) Summary
Inline snapshot updates for patch and prerelease PRs
scripts/release/__tests__/generate-pr-description.test.ts
Both mapToChangelist inline snapshots updated: - [ ] checkboxes removed from Bug, Feature Request, Documentation, and Missing Label bullets; Direct commit bullet retains the - [ ] checkbox format.
checkReleaseChecklist JSDoc parameter
scripts/dangerfile.js
Added missing @param {string} body annotation in the JSDoc comment block for checkReleaseChecklist.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • storybookjs/storybook#35171: Introduced the mapToChangelist checkbox/checklist formatting change in generate-pr-description.ts that these snapshot updates reflect, along with the checkReleaseChecklist function signature being documented.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands and usage tips.

@Sidnioulz Sidnioulz merged commit ae44b24 into next Jun 17, 2026
143 checks passed
@Sidnioulz Sidnioulz deleted the sidnioulz/fix-pr-description-test branch June 17, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Internal-facing build tooling & test updates ci:normal Run our default set of CI jobs (choose this for most PRs). qa:skip Pull Requests that do not need any QA.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants