-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sandboxes: Continue partial publishing if some sandboxes fail to generate #26013
Merged
JReinhold
merged 23 commits into
next
from
jeppe/25922-ci-generation-of-sandboxes-fail-sometimes-on-prereleases
Mar 5, 2024
Merged
Sandboxes: Continue partial publishing if some sandboxes fail to generate #26013
JReinhold
merged 23 commits into
next
from
jeppe/25922-ci-generation-of-sandboxes-fail-sometimes-on-prereleases
Mar 5, 2024
Conversation
This file contains 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
…sometimes-on-prereleases
yannbf
approved these changes
Mar 5, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
17 tasks
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.
Closes #25922
What I did
This PR adds support for partial generation+publishing of sandboxes, meaning that if some of the sandboxes fail to generate, the rest will still finish and publish.
generate
script to continue successful sandboxes, and add better and more readable error logging. When run in CI, a summary table will show each sandbox and their result - one of "Pass", "Failed to execute before-script", "Failed to initialize Storybook" or "Failed with unknown error". Any error will also be logged as a GH Actions error annotation which has more info, however Actions have a limit of 10 annotations per job.publish
script has been changed to not empty all sandbox directories before copying the generated ones over, but instead only delete thebefore-storybook
andafter-storybook
directories where corresponding successful sandboxes are present.Checklist for Contributors
Testing
This is an example of a fully successful job: https://github.com/storybookjs/storybook/actions/runs/7885839554
And a job with (simulated errors): https://github.com/storybookjs/storybook/actions/runs/7883911413
The changes in this PR are covered in the following automated tests:
Manual testing
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:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>