CICD-Tools

Managed, Centralized CI/CD Components. A platform in a repository.

Builds: main

Builds: dev

About

This repository manages a group of tools used to add out-of-the-box CI/CD pipeline functionality to Git based projects.

Supported CI Platforms

At the current time only GitHub Actions are supported, but the future may bring more integrations.

Technical Overview

CICD-Tools provides four consumables to end-user projects that together form the basis of a managed CI solution:

1. Customized pre-commit hooks for end-user projects.
2. A custom Docker container which supplies the required binary tools for the pre-commit hooks.
3. Remotely consumable GitHub "Jobs" that are actively maintained.
4. A custom packaging system that securely delivers upgradable Toolboxes full of scripts for the workflows.

For more details on these components, please read the complete Technical Overview.

Supported Project Installations

CICD-Tools supports the following types of installs:

1. Cookiecutter Template Installs
   • Please see the cookiecutter installation guide for details on:
     • installing CICD-Tools into cookiecutter templates
     • setting up CI/CD for templates and spawned projects
     • setting up pre-commit for templates and spawned projects
2. Standard Project Installs (Projects may use Python, Shell or other languages.)
   • Please see the standard installation guide for details on:
     • installing CICD-Tools into existing projects
     • setting up CI/CD for existing projects
     • setting up pre-commit for existing projects
3. Lightweight Project Installs (Projects may use Python, Shell or other languages.)
   • Please see the light installation guide for details on:
     • installing CICD-Tools into existing projects
     • setting up pre-commit for existing projects

License

MPL-2