GitHub actions provide a convenient place to run validation scripts for the project, e.g., build, black, flake8, pytest.
There should be a YAML file under .github/workflows/
folder as part of the repository that will be executed automatically based on configuration (usually on push and/or when creating a new pull request).
Name of the action and the trigger.
name: build
on: [push, pull_request]
The jobs component sets up the server and the steps that should be executed. In this example we install dependencies; run tests for black
, flake8
, mypy
, docformatter
, pydocstyle
, and pytest
;