Skip to content

CI/CD tools

Current version to use: v1

Use tried and tested continuous integration (CI) and continuous deployment (CD) tools from this repository.

Currently, the repository offers GitHub Actions callable/reusable workflows and pre-commit hooks.

GitHub Actions callable/reusable Workflows

This repository contains reusable workflows for GitHub Actions.

They are mainly for usage with modern Python package repositories.

Available workflows

The callable, reusable workflows available from this repository are described in detail in this documentation under the Workflows section.

General usage

See the GitHub Docs on the topic of calling a reusable workflow to understand how one can incoporate one of these workflows in your workflow.

Note

Workflow-level set env context variables cannot be used when setting input values for the called workflow. See the GitHub documentation for more information on the env context.

Under the Workflows section for each available workflow, a usage example will be given.

pre-commit hooks

This repository contains hooks for keeping the documentation up-to-date, making available a few invoke tasks used in the reusable workflows.

By implementing and using these hooks together with the workflows, one may ensure no extra commits are created during the workflow run to update the documentation.

Available hooks

The pre-commit hooks available from this repository are described in detail in this documentation under the Hooks section.

General usage

Add the hooks to your .pre-commit-config.yaml file. See the pre-commit webpage for more information about how to use pre-commit.

Under the Hooks section for each available hook, a usage example will be given.

This repository licensed under the MIT LICENSE with copyright © 2022 Casper Welzel Andersen (CasperWA).