Build: Stop writing version JSON-files when publishing#34642
Merged
Conversation
Contributor
Contributor
📝 WalkthroughWalkthroughThis PR removes the automatic synchronization mechanism for version JSON files from the release and publish workflows. The changes eliminate GitHub workflow steps, helper functions, test assertions, and documentation related to maintaining Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@scripts/release/__tests__/write-changelog.test.ts`:
- Around line 56-57: Replace direct access to the mock internals of
fsp.writeFile with a typed mock via vi.mocked to match the pattern used for
changesUtils; specifically, wherever the test reads fsp.writeFile.mock.calls
(e.g., in the assertions around STABLE_CHANGELOG_PATH at lines referenced and
the other two occurrences), change those to vi.mocked(fsp.writeFile).mock.calls
so the assertions use the typed mock wrapper (keep the rest of the assertions
the same).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 32dcdbfd-9151-4fd3-9cf2-43e2ac6d8e8d
📒 Files selected for processing (8)
.github/workflows/publish.yml.oxfmtrc.jsonCONTRIBUTING/RELEASING.mddocs/versions/latest.jsondocs/versions/next.jsonscripts/release/__tests__/write-changelog.test.tsscripts/release/generate-pr-description.tsscripts/release/write-changelog.ts
💤 Files with no reviewable changes (6)
- scripts/release/generate-pr-description.ts
- docs/versions/latest.json
- docs/versions/next.json
- .github/workflows/publish.yml
- scripts/release/write-changelog.ts
- CONTRIBUTING/RELEASING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See companion PR in docs repo: storybookjs/web#401
What I did
When building our docs, we now pull the latest release and prerelease versions of Storybook directly from npmjs, instead of relying on us generating these JSON files and pulling them into the docs repo. So I've removed the generation of said files here.
One less step to screw up! 💪
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
Chores
Documentation