Ctrl+K

Workflows

Github has loads of features that can improve the quality of your code. We will cover some of these features in this section.

Workflows#

A Github workflow is a way of creating executable jobs that is executed either when committing to a branch, creating a pull request or creating a release/tag. They are specified in YAML-formatting.

More information about workflows can be found in the Github Documentation

A workflow should be placed in the .github repository as shown below

└── .github
    └── workflows
        ├── test_code.yml
        └── publish_docs.yml

Actions#

Github Actions is a prebuilt set of instructions to make it easier to interact with Github. The actions officially maintained by Github can be found at: GitHub/actions

Uploading artifacts#

As covered in the Coverage report-section, we use the Upload artifact action

Publishing to Pages#

There are several ways to publish a set of html files to Github Pages. One can either:

  1. Official actions: See custom Github Actions to publish your site for details

  2. Unofficial action: Preceding Github’s official actions peaceiris/actions-gh-pages was a popular option

Contents