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

[proposal] add github actions to templates #438

Closed
swyxio opened this issue Jan 22, 2020 · 10 comments · Fixed by #457
Closed

[proposal] add github actions to templates #438

swyxio opened this issue Jan 22, 2020 · 10 comments · Fixed by #457
Labels
kind: discussion Discussion on changes to make kind: feature New feature or request scope: templates Related to an init template, not necessarily to core (but could influence core)

Comments

@swyxio
Copy link
Collaborator

swyxio commented Jan 22, 2020

Current Behavior

gh actions are awesome. lets recommend and auto scaffold some for people to test their tsdx libraries? i know not everybody uses github but they could just delete the .github folder if so.

pull some from https://github.com/sdras/awesome-actions

what actions would people like?

e.g. i'd like matrix testing by default, as well as issue/pr templates

@agilgur5
Copy link
Collaborator

agilgur5 commented Jan 22, 2020

I think basic issue/PR templates that can then be customized per library would be great (and are often under-prioritized) and are fairly universal too.

I'm ambivalent about Actions. I use Travis for my libraries and it's a lot more reliable, readable, and functional than GH (e.g. simple things like restarting a test) and has one-liner code coverage integration. On the one hand, it's much easier to delete stuff than to add stuff, but that can quickly spiral into having too many things to delete.

As more stuff gets added to the templates (e.g. actions, storybook, etc), it might make sense to have TSDX wrap more of that functionality internally instead of exposing all the config to users (that would also mean that instead of needing to delete something, you just don't use that functionality, which is even easier).

@kylemh
Copy link
Contributor

kylemh commented Jan 22, 2020

Is there a way to do this with some system better than templates? What if I want Storybook TSDX + GitHub Actions?

I can easily make a PR for the actions config FWIW, just not sure how to integrate it well as part of the TSDX CLI.

@swyxio
Copy link
Collaborator Author

swyxio commented Jan 23, 2020

idk i was thinking just add some files, but come to think about it maybe we want a new tsdx actions command to scaffold stuff 🤷‍♂ all i know is, it is seriously best practice to have CI for every library, and actions is the dead easiest way to do it

@kylemh
Copy link
Contributor

kylemh commented Jan 23, 2020

Do we just wanna add it by default to all templates?

@swyxio
Copy link
Collaborator Author

swyxio commented Jan 23, 2020

i think so. i do wanna get a 👍 or 👎 from @jaredpalmer before we proceed brainstorming any further

@jaredpalmer
Copy link
Owner

Yeah, I would add a workflows to templates.

I want to keep the core lean going forward, but I’m open to a new cli command like: tsdx add ... and tsdx remove. This could allow folks to write project manipulations going forward they are standardized

@kylemh
Copy link
Contributor

kylemh commented Jan 24, 2020

Okay, cool. For this change of course, it's easy for people to just delete the .github folder that will be included to opt-out.

@swyxio
Copy link
Collaborator Author

swyxio commented Jan 24, 2020

let's get something small in. basic test action?

@kylemh
Copy link
Contributor

kylemh commented Jan 24, 2020

I'll get this tomorrow 🕺

@swyxio
Copy link
Collaborator Author

swyxio commented Jan 25, 2020

alright, we have basic actions merged: #457 thanks Kyle!

i'm sympathetic to @agilgur5's concerns, and dont wanna bloat too much overnight. Maybe lets see this go out in the next release and take feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: discussion Discussion on changes to make kind: feature New feature or request scope: templates Related to an init template, not necessarily to core (but could influence core)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants