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

Create all Github actions workflows needed #12

Closed
ixahmedxi opened this issue Apr 5, 2024 · 4 comments · Fixed by #42
Closed

Create all Github actions workflows needed #12

ixahmedxi opened this issue Apr 5, 2024 · 4 comments · Fixed by #42

Comments

@ixahmedxi
Copy link
Owner

ixahmedxi commented Apr 5, 2024

OrbitKit needs to also deliver github actions as part of the starterkit to help people have a solid foundation where their work is tested and checked, I have a few ideas for the kind of actions we need but here's what my mind thinks:

  • Obviously the normal lint, typecheck, build, checks (turborepo)
  • We need to do it so that a Neon DB branch is created for every new Pull Request, which gets consumed by the actions of that pull request and when the pull request is closed or merged, we need to run an action that will destroy that branch.
  • We also need the github action to integrate with chromatic/storybook and mintlify
  • I am not sure if we will need to handle vercel deployment from the github actions, because I was thinking it would actually maybe be a good idea for every pull request to have two db branches on neon, one is used for the github actions to run the e2e tests on top...etc and another one is created from the neon vercel integration for the preview deployment that way you don't get e2e test specific data into your preview deployment, further increasing accuracy between both preview and production deployment.
  • We can put in templates for slack/discord messaging through the github actions maybe.

Would love to hear more thoughts about this as that I'm not the most knowledgable person when it comes to github actions.

@xMohamd
Copy link
Contributor

xMohamd commented Apr 6, 2024

More details? What kind of actions do you need?

@ixahmedxi ixahmedxi changed the title Github Actions Create all Github actions workflows needed Apr 6, 2024
@ixahmedxi
Copy link
Owner Author

More details? What kind of actions do you need?

Hello @xMohamd sorry I have now updated the description of this issue to reflect more about what I mean. Thank you!

@raoufchebri
Copy link

Hey @ixahmedxi, are you thinking of using Neon GitHub Actions to create and delete branches?
https://github.com/marketplace/actions/neon-database-create-branch-action
https://github.com/marketplace/actions/neon-database-delete-branch

@ixahmedxi
Copy link
Owner Author

Hey @ixahmedxi, are you thinking of using Neon GitHub Actions to create and delete branches?

https://github.com/marketplace/actions/neon-database-create-branch-action

https://github.com/marketplace/actions/neon-database-delete-branch

Hey @raoufchebri yes that is exactly correct, I was actually looking at it a while ago and it seemed like a perfect fit for this purpose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants