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

Move plugin setup script to development tools #2604

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

garrettjstevens
Copy link
Collaborator

This proposes moving the plugin template setup script to @jbrowse/development-tools instead of having it in the plugin template. The script is meant to be run once when setting up the plugin, so having it in the template means having files that users can clean out, but there's no indication to them of whether they'll need it again. This way it avoids having the extra files in the template in the first place.

@garrettjstevens garrettjstevens self-assigned this Dec 21, 2021
@github-actions github-actions bot added the needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) label Dec 21, 2021
@codecov
Copy link

codecov bot commented Dec 21, 2021

Codecov Report

Merging #2604 (a726abe) into main (e2bbd6b) will decrease coverage by 0.21%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2604      +/-   ##
==========================================
- Coverage   60.80%   60.59%   -0.22%     
==========================================
  Files         558      559       +1     
  Lines       25723    25816      +93     
  Branches     6069     6083      +14     
==========================================
  Hits        15642    15642              
- Misses       9754     9847      +93     
  Partials      327      327              
Impacted Files Coverage Δ
packages/development-tools/src/setup.ts 0.00% <0.00%> (ø)

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 e2bbd6b...a726abe. Read the comment docs.

@cmdcolin
Copy link
Collaborator

is there any way we can take advantage of the yarn create jbrowse-plugin type templates?

@garrettjstevens
Copy link
Collaborator Author

yarn create doesn't provide any templating tools itself, it just runs an executable that you have to provide, so we'd have to come up with a way to create a repo from a template ourselves. If we want to do something simple, we could do something like gh repo create --template does.

@cmdcolin
Copy link
Collaborator

my personal vote would be against this PR, because I think it is less of a black box when the code is in the plugin template itself. when it's just in the plugin template, a user can just rm -rf the setup script once they are done with it if they are interested (i often do this to make the repo size smaller for my plugins)

it is more lines of code in one way in the plugin template, but easier to remove

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants