Skip to content
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

Update to Storybook v7 #2748

Merged
merged 1 commit into from
Feb 27, 2023
Merged

Update to Storybook v7 #2748

merged 1 commit into from
Feb 27, 2023

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Feb 26, 2023

Changes

Apply the following changes to perform the bulk of the migration:

  • npx storybook@next upgrade --prerelease This includes a number of automigrations which update core config to match the new v7 API
  • Disable storyStoreV7 as a temporary workaround for an error loading stories. This will be re-enabled (v7 default) once the remaining issues are resolved
  • Disable auto docs generation for now, need to clean up stories to properly take advantage of CSF3 benefits etc.
  • Migrate to CSF3 story structure and syntax
    npx storybook@next migrate csf-2-to-3 --glob="src/**/*.stories.js"
    npx storybook@next migrate csf-2-to-3 --glob="packages/**/*.stories.js"
    This is only a partial migration and the remainder will need to be completed manually to take full advantage of the improvements and simplifications introduced in CSF3
  • Remove the root prefix in each story (e.g. Components/) and move to a centralised config in .storybook/main.js via the stories entry. Experiemental components etc. will be identified differently after the CSF3 migration is completed fully

/kind misc

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/misc Categorizes issue or PR as a miscellaneuous one. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 26, 2023
@AlanGreene
Copy link
Member Author

/test pull-tekton-dashboard-integration-tests

@AlanGreene
Copy link
Member Author

AlanGreene commented Feb 26, 2023

Failing installing kubectl in the E2E docker image:

Step 2/12 : RUN curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg &&    echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | tee /etc/apt/sources.list.d/kubernetes.list &&    apt-get update && apt-get install -y     kubectl     && rm -rf /var/lib/apt/lists/*
 ---> Running in 9024b2a0b8a1
curl: (22) The requested URL returned error: 404 

Others seeing similar issues: kubernetes/kubernetes#116068
Possibly related to Google incident.

I'll investigate tomorrow and explore workarounds if it's not resolved.

Note to self: Now might be a good time to consider cypress/factory to create and manage our own Cypress image with desired Node.js + browser versions instead of waiting for updated cypress/browsers image (latest Node.js 18 + Chrome image is currently 3 months old), and include kubectl or other tools so we don't have to install them at runtime and reduce likelihood of encountering this or other similar issues.

@AlanGreene
Copy link
Member Author

/test pull-tekton-dashboard-integration-tests

Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 27, 2023
Apply the following changes to perform the bulk of the migration:
- `npx storybook@next upgrade --prerelease`
  This includes a number of automigrations which update core config to
  match the new v7 API
- Disable `storyStoreV7` as a temporary workaround for an error
  loading stories. This will be re-enabled (v7 default) once the
  remaining issues are resolved
- Disable auto docs generation for now, need to clean up stories
  to properly take advantage of CSF3 benefits etc.
- Migrate to CSF3 story structure and syntax
  `npx storybook@next migrate csf-2-to-3 --glob="src/**/*.stories.js"`
  `npx storybook@next migrate csf-2-to-3 --glob="packages/**/*.stories.js"`
  This is only a partial migration and the remainder will need to
  be completed manually to take full advantage of the improvements
  and simplifications introduced in CSF3
- Remove the root prefix in each story (e.g. `Components/`) and move
  to a centralised config in `.storybook/main.js` via the `stories`
  entry. Experiemental components etc. will be identified differently
  after the CSF3 migration is completed fully
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2023
Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2023
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot merged commit a0f17a1 into tektoncd:main Feb 27, 2023
@AlanGreene AlanGreene deleted the storybook_v7 branch February 27, 2023 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants