devops: add GitHub action workflow for PRs

[kylejb]

Description

Create first GitHub Actions workflow, which will execute tests for every PR attempting to merge to main. Tests must passed in order to be allowed to merge.

TODOs

Please ensure all of these TODOs are completed before asking for a review.

• Ensure the branch is named correctly with the issue number. e.g: feat/310-new-endpoint or bug/322-fix-missing-param.
• Update the docs.
• Keep the changes backward compatible where possible.
• Run the pre-commit checks successfully.
• Run the relevant tests successfully.

[Grieze]

What's the point of github workflows and the yml files? I have no idea what they're for. I'm assuming this is for making working with github easier.

[kylejb]

This is still a work-in-progress. I want to also create a service process to run a postgresql database in order to run tests on for github actions.

What's the point of github workflows and the yml files? I have no idea what they're for. I'm assuming this is for making working with github easier.

The yml files is what GitHub uses to create workflows in our repository. It's particularly useful for automating CI/CD processes. I'd like to incorporate this for our pull requests.

As an example:

• We create a new Pull Request
• Workflow starts:
  • installs repository on a new server
  • runs tests on that new server (to mimic production environment)

This will help us catch critical errors earlier on. And it also will help us review each other's PRs; you won't have to run the tests locally yourself.