ichec_cicd

This project is a collection of utilities for managing CI/CD pipelines at ICHEC.

It provides opinionated interfaces to encourage standarization of our project structures and workflows.

Install

The package is available from PyPI:

pip install ichec_cicd

Features

Deploy a Package to a Repository

From the package's top-level directory:

ichec_cicd deploy --token $REPO_TOKEN

As an example, for a Python project this might be the PyPI repository's token.

Set a Package's Version Number

From the package's top-level directory:

ichec_cicd set_version $VERSION

Increment a Repository's Tag

From the repository's top-level directory, and on the branch the tag will be dervied from:

ichec_cicd increment_tag --field patch

Here semver tag versioning is assumed with a major.minor.patch scheme. Note: in a CI/CD pipeline some more input options are needed to initialize the git repo for pushing the tag to. You can use the --help flag for more details.

Sync Content With an External Upstream

Here we pull content from an external upstream repository and use it to update the content in a local repo. This can be useful for public mirrors that include a subset of the content in an internal repo.

ichec_cicd sync_external_archive \
    --source_token $SOURCE_TOKEN \ 
    --project_id $SOURCE_PROJ_ID \
    --sync_script $MY_SYNC_SCRIPT \
    --asset_name $ASSET_NAME \
    --archive_name $ARCHIVE_NAME \
    --target_token $TARGET_TOKEN

The inputs are:

• SOURCE_TOKEN: Gitlab access token for the source (private) repo - must have asset download rights
• SOURCE_PROJ_ID: The numeric project ID for the source repo
• MY_SYNC_SCRIPT: Path to a script that will use the extracted contents of the source archive to update the target repo
• ASSET_NAME: Name of the asset corresponding to the archive in the source repo's latest release collection
• ARCHIVE_NAME: Name of the downloaded file corresponding to the archive - this can differ from the asset name.
• TARGET_TOKEN: OATH token for the target repo - so that it can be pushed to from a CI runner

Generate a containerfile

Here we generate a containerfile from a template given a release manifest in a repo:

ichec_cicd containerfile generate --manifest <path_to_manifest> --template_dir <container_templates> 

where <path_to_manifest> is the path to an ICHEC release manifest and <container_template> is a directory with container templates.

Containerize a Web App

Here we set up a standardized container build context for web applications, i.e. Django or FastAPI apps.

ichec_cicd wrap --project <project_to_wrap> --template <wrapping_template> 

where <project_to_wrap> is a url or filesystem path to a repository with the project to be wrapped and <wrapping_template> is a url or path to a repository with a template to do the wrapping. The project to be wrapped needs to have an ichec_manifest.yml file at its top level with package metadata and the <wrapping_template> should match the framework being used, e.g. (Django/FastAPI).

Check Prose

Check the repo's Markdown, and the comments in its Python, JavaScript, TypeScript and YAML files, against the house writing style:

ichec_cicd prose

It runs Vale with the ICHEC style in src/ichec_cicd/prose/styles, and limits comment blocks to 3 lines and docstrings to 10. If the repo has a .prose-budget.json, each Markdown file must also stay within its line budget. Run ichec_cicd prose --tighten to create the budget or lower it after a cleanup. Budgets never go up automatically. To raise one, edit the file in the MR.

In a Python repo, run it as a tox env so it runs locally and in CI with everything else.

Licensing

This project is licensed under the MIT License. See the accompanying LICENSE file for details.