search

TyXe-BDL / TyXe

MIT License
144 stars 33 forks source link

Add github actions #23

Open icfly2 opened 2 years ago

icfly2 commented 2 years ago

Added github actions to run tests

Requirements moved out of setup.py to enable instalation in github action runner.

hpplyt commented 1 year ago

Thanks for setting this up! Sorry for the incredibly delayed response, I had been away during August and had to catch up on a couple of things.

Are you following a specific tutorial here or building off another repo? I'm just wondering if I'll need to enable a CI service for the repo somewhere or if having the workflow yaml is enough.

Also, is there any way we can test if things are working correctly before merging this? Perhaps we could merge it into a different branch than master first and see if things run there? In particular I'd like to also include running the examples and the regression notebook in the workflow, which might require a couple of small adjustments here or there so it's quick to execute. We can do this separately from this PR of course, I'm just thinking it might be good to have a separate branch to avoid breaking things in master.

I'll leave #20 open until we've merged this and use it as a test for the CI if that's ok.

icfly2 commented 1 year ago

I don't know how it can be tested on here before going in. But if you like I can change the target to be a different branch and then the action will run there first. I think you'd need to create that branch first though.

As for the guidance, it is the general github action setup, I use this + the packaging one, which I'll add next for all of my projects (open source and work) You can see the runs for my fork here.

I think it is a great idea to run the examples in the CI too. And it is easy to edit this workflow to run them, I can can do that next, I figured it would be nice to get this workflow going first and then look at adding examples etc to keep things simple.

hpplyt commented 1 year ago

Sounds good, I've set up a branch called ci-test, happy to merge this PR there to confirm that everything works :)

And fully on board with keeping things simple, I'll merge this first and then we can look into adding the examples. Let me know if you'd rather have me do this, I should be able to find some time over the week.