-
Notifications
You must be signed in to change notification settings - Fork 64
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
1469 storybook deploy #1770
1469 storybook deploy #1770
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1770 +/- ##
==========================================
- Coverage 58.68% 58.68% -0.01%
==========================================
Files 459 459
Lines 21278 21278
Branches 5020 5020
==========================================
- Hits 12488 12486 -2
- Misses 8480 8482 +2
Partials 310 310
Continue to review full report at Codecov.
|
This reverts commit 895f631.
Also remove some unneeded resolutions and deps from package.json
Could you elaborate on how that works? |
Yeah, definitely. Here is an example of what the links will look like: link for this branch A static build of the storybook site gets generated on each push for each branch. This mirrors how we are currently doing, static builds like: https://s3.amazonaws.com/jbrowse.org/code/jb2/master/index.html Ultimately, the docs link will look like: https://jbrowse.org/storybook/v1.0.x which will be the Storybook docs for that stable release. The benefit of this is that liking having a live build for each branch, we will have live examples of the React component for each branch. It makes it easier to detect if changes on that branch might break the React component, etc. |
This should be good to go. One note: It is probably going to be necessary to wait to update the docs until we release again, because that will be when there will be the first valid stable version URL for the link. |
There is a story for runtime-loaded plugin for the embedded component, that is non-functional though right? Would be cool to get an example for that |
Runtime and or non default plugin....either one |
This PR implements a deployment of our Storybook stories into a docs site for the embeddable LGV React component. (Closes #1469 )
After talking with @cmdcolin , this was designed to be built on each push for each branch. The current release tag will serve as the actual docs site that is linked to. One nice feature/use of this is that this will serve as a way to detect if any changes we are making are going to break the embeddable component while we develop.
Currently a draft, still working out:
The Github Actions workflowAdding a link to the Storybook site from the docs