Overview

The following list categorizes all pre-defined job templates, which can be instantiated in a pipeline (GitHub Action Workflow). They can also serve as an example for creating or driving own job templates.

Table of Contents:

Global Templates Parameters Unit Tests, Code Coverage, Code Quality, … UnitTesting CoverageCollection StaticTypeCheck code formatting (planned) coding style (planned) code linting (planned) Build and Packaging Package

Documentation VerifyDocs BuildTheDocs Releasing, Publishing Release PublishOnPyPI PublishTestResults PublishToGitHubPages Cleanups ArtifactCleanUp

Instantiation

When instantiating a template, a jobs:<Name>:uses is used to refer to a template file. Unfortunately, besides the GitHub SLUG (<Organization>/<Repository>), also the full path to the template needs to be gives, but still it can’t be outside of .github/workflows to create a cleaner repository structure. Finally, the path contains a branch name postfixed by @<branch> (tags are still not supported by GitHub Actions). A jobs:<Name>:with: section can be used to handover input parameters to the template.

on:
  push:
  workflow_dispatch:

jobs:
  <InstanceName>:
    uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@v0
    with:
      <Param1>: <Value>