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

Add example for using a build-time included plugin to storybook #1862

Merged
merged 3 commits into from
May 6, 2021

Conversation

cmdcolin
Copy link
Collaborator

The storybook has an example of runtime-including a plugin but it is actually probably more common to use build-time plugins, so I added an example of that here

This adds a devDependency on jbrowse-plugin-ucsc to use as an example

@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 31, 2021
@cmdcolin cmdcolin changed the title Add buildtime example to storybook Add example for using a build-time included plugin to storybook Mar 31, 2021
@cmdcolin cmdcolin added documentation and removed needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) labels Mar 31, 2021
@cmdcolin
Copy link
Collaborator Author

appears to have some issues with a postinstall step, maybe put into draft

@cmdcolin cmdcolin marked this pull request as draft March 31, 2021 18:12
@cmdcolin
Copy link
Collaborator Author

this did work locally though which was interesting

@cmdcolin cmdcolin force-pushed the add_buildtime_example_to_storybook branch from b39e991 to d42ea7b Compare April 12, 2021 18:26
@cmdcolin
Copy link
Collaborator Author

This may have to be closed if we can't resolve the build issue/CI. I think it's worthwhile to make sure that we document how to use build-time plugins, and having an example like this would be good but it causes the CI failure. Any ideas? something related to plugin postinstall script

@elliothershberg
Copy link
Member

elliothershberg commented Apr 13, 2021

Hmm, yeah that would be good to have. I can try taking a look at this later.

@cmdcolin cmdcolin force-pushed the add_buildtime_example_to_storybook branch from d42ea7b to 744d3db Compare April 19, 2021 21:32
@cmdcolin
Copy link
Collaborator Author

cmdcolin commented Apr 19, 2021

This now uses a source code comment to describe how to use build time plugins, rather than provide an actual example that uses build time plugins

@codecov
Copy link

codecov bot commented Apr 19, 2021

Codecov Report

Merging #1862 (2c19a3c) into main (4d42689) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1862   +/-   ##
=======================================
  Coverage   58.80%   58.80%           
=======================================
  Files         460      460           
  Lines       21735    21735           
  Branches     5198     5198           
=======================================
  Hits        12781    12781           
  Misses       8653     8653           
  Partials      301      301           

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 4d42689...2c19a3c. Read the comment docs.

@cmdcolin cmdcolin force-pushed the add_buildtime_example_to_storybook branch from 744d3db to 2c19a3c Compare May 3, 2021 16:16
@cmdcolin cmdcolin marked this pull request as ready for review May 6, 2021 20:10
@cmdcolin
Copy link
Collaborator Author

cmdcolin commented May 6, 2021

this pr was pared down to basically just a comment now

@cmdcolin cmdcolin merged commit 15f8ad0 into main May 6, 2021
@cmdcolin cmdcolin deleted the add_buildtime_example_to_storybook branch May 6, 2021 20:11
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.

2 participants