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

1469 storybook deploy #1770

Merged
merged 47 commits into from
Mar 18, 2021
Merged

1469 storybook deploy #1770

merged 47 commits into from
Mar 18, 2021

Conversation

elliothershberg
Copy link
Member

@elliothershberg elliothershberg commented Mar 8, 2021

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 workflow
  • Adding a link to the Storybook site from the docs

@github-actions github-actions bot added the needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) label Mar 8, 2021
@elliothershberg elliothershberg added documentation and removed needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) labels Mar 8, 2021
@codecov
Copy link

codecov bot commented Mar 8, 2021

Codecov Report

Merging #1770 (998efa3) into master (0d5493d) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            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              
Impacted Files Coverage Δ
...inearGenomeView/components/RefNameAutocomplete.tsx 89.36% <0.00%> (-4.26%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update adb2b43...998efa3. Read the comment docs.

@rbuels
Copy link
Contributor

rbuels commented Mar 11, 2021

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.

Could you elaborate on how that works?

@elliothershberg
Copy link
Member Author

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.

@elliothershberg elliothershberg marked this pull request as ready for review March 12, 2021 17:49
@elliothershberg
Copy link
Member Author

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.

@cmdcolin
Copy link
Collaborator

cmdcolin commented Mar 15, 2021

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

@cmdcolin
Copy link
Collaborator

Runtime and or non default plugin....either one

@rbuels rbuels merged commit 7808c70 into master Mar 18, 2021
@rbuels rbuels deleted the 1469_storybook_deploy branch March 18, 2021 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deploy Storybook for JBrowse React Linear Genome View
4 participants