Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 781 Bytes

Actions.md

File metadata and controls

22 lines (13 loc) · 781 Bytes

GitHub Actions

GitHub actions provide a convenient place to run validation scripts for the project, e.g., build, black, flake8, pytest.

Setup

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).

Components

General

Name of the action and the trigger.

name: build

on: [push, pull_request]

Jobs

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;