GitHub Action to run the tests on every pull request

[cclauss]

Test output: https://github.com/cclauss/maxdevtools/actions

[MattijsKneppers]

Thank you for this PR @cclauss, which immediately points out a flaw in the tests that was introduced some time ago (now fixed with #19). We're looking into this PR and get back to you.

[cclauss]

Rebased to the main branch just to prove that #19 fixed the tests.

• Make maxdiff tests work again #19

[MattijsKneppers]

Would you agree that it is not necessary to run the tests for every Push action, but only as a required check before merging?

[jamesb93]

I was actually looking to see if anyone had already done something like this for PRs. Would be most handy. I agree checking every push is unnecessary right now, and just making sure tests pass for each PR would be ideal.

[cclauss]

GitHub's Python docs seem to favor on: [push] but I am flexible.

• https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#using-multiple-python-versions

It is useful if contributors and reviewers can see the tests pass before starting the code review.

[MattijsKneppers]

Thanks @cclauss. I am not very familiar with setting up github checks, so do I understand correctly that having them on push would re-trigger the checks on every push? In that case I agree having them on push makes sense.

[cclauss]

Simplified to just on: [push].

[cclauss]

The nice explanation can be found at

• Don't duplicate CI checks on PRs FactoryBoy/factory_boy#1075

[cclauss]

If you are going to run prbase then you should probably enable contributors to rebase their PRs on the current branch.

• https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests

[MattijsKneppers]

@cclauss thanks for all the updates. I requested for rebasing to be enabled and will let you know when that has happened.

In the mean time, I wonder if you have noticed the requirement in the contributing guidelines that Ableton has received a CLA from any contributors. Would you be able to submit one for us?

[cclauss]

Done.

[ala-ableton]

This means the workflow will trigger when a branch in this repository (not in a fork) is pushed to. So when an external contributor opens a new pull request, it won't trigger the workflow.

[cclauss]

Changed to follow the factory-boy example.

[MattijsKneppers]

Hi @cclauss, we had another look and have a few questions:

• it looks like pull_request needs to be pull_request_target in order to run from forks, would you be able to change that?
• nitpick:
  • since we're only testing a single python version, perhaps having the matrix entry is not needed and the 3.x version can just be in-lined in python-version: ${{ matrix.python-version }}.
  • OR: since ubuntu-latest already comes with python 3.10.x, perhaps actions/setup-python@v5 is not needed at all.

Thanks again for your ongoing attention to this!

[cclauss]

Do these three suggestions cover it?

[MattijsKneppers]

@cclauss they do, thank you!

[MattijsKneppers]

Hi @cclauss, sorry for the long wait. We needed a bit more discussion, but it's all approved now. It would be great if you can rebase one last time and then I can merge.

[cclauss]

Rebased.

[ala-ableton]

The current state of .github/workflows/ci.yml is an old state, and is not what we want to merge to this repository. Please restore the state that was in 4fc0a77.