CI with GitHub Actions?

[ZanSara]

As a contributor I would find very useful to have a small CI, for example I'd like to see the tests running on the PRs I open, as a sanity check. Having a Linux machine, I can't test on Windows and MacOS for example, so I can't tell if my changes are breaking on someone else's platform.

Would you consider adding such features to this project? I can volunteer to implement them if you are happy with the idea.

[Mandera]

This'd be great - workflow is generated here

• Should probably create separate tests without env vars for security reasons
  • Maybe those tests could dynamically be skipped if EnvVar's failing to fetch?
    • Similar to generalimport's custom error!
• Should it be the complete matrix or a light version?
• Reduce unittest duration #28 would be nice but not necessary

Somewhat related to

• Update workflow #61

[ZanSara]

I think the matrix is very valuable! I should add that to Canals too

[Mandera]

I've already done some research here

• Checkout workflow running for branches other than master #48

The issue I ran into there can be solved by cloning the current branch for the repo each workflow belongs to
git clone -b ${{ github.ref_name }} --single-branch ssh:https://[email protected]/ManderaGeneral/generalpackager.git

https://stackoverflow.com/questions/58033366/how-to-get-the-current-branch-within-github-actions
https://stackoverflow.com/questions/1911109/how-do-i-clone-a-specific-git-branch

Possible problem with shared branches

I foresee an issue where you are working on a feature spanning multiple repos, then tests will never pass...
Could make workflow dynamically checkout ${{ github.ref_name }} for every repo!
Not sure how to avoid exit code if done through cli
Could create a step for each repo and use continue-on-error

Checking out branches has a tiny chance to create use-case where you didn't intend to share the same branch name with another repo, that's probably fine though.

When we start making use of artifacts we could create a nice little table for which branch was used for each repo

[Mandera]

Current simple plan

• Make EnvVars raise skiptest exception
• Create a new workflow file for pushing to all branches but master
• Run matrix tests

Idea for clean git history

Once this is incorporated we could

• Protect master
• Create pull requests
• Tests pass
• Squash commits, maintain author somehow
• Rebase onto master

This will give us a much nicer git history moving forward

p.s: Just realized we cannot really do this, I don't want to run actions with any credentials meaning some tests won't run and we won't be able to make new commits onto the branch (possibly only allow that one?)