# jsburckhardt/devcontainer-features architecture

> Architecture diagram of the GitHub repository jsburckhardt/devcontainer-features, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jsburckhardt/devcontainer-features
- Repository: https://github.com/jsburckhardt/devcontainer-features

## Overview

The project is a repository that provides a collection of devcontainer features. Each feature is essentially a CLI tool integration (like flux, notation, crane, etc.) that gets added to a container environment (based on the Ubuntu devcontainer image). The repository is organized in a modular way with each feature in its own folder under the “src” directory, and corresponding tests in the “test” directory. There is also CI/CD support via GitHub workflows and configuration files (like .devcontainer.json, makefile, and container configuration files) to streamline building, testing, and releasing these features.

##### Main Components
- DevContainer Base Image: At the center stands the container environment (using “mcr.microsoft.com/devcontainers/base:ubuntu”) which is the common platform for running the features.
- CI/CD Pipeline: Represent GitHub workflows (release and test pipelines) that automate the building and testing of these features.
- Test Suites: Represent the “test” directory that contains global testing scripts and individual feature tests, showing how each feature is validated.
- Configuration and Tooling: Include configuration files (like makefile, .devcontainer.json, and .gic.yaml) as they support building and environment setup.

##### Relationships and Interactions
- The DevContainer Base Image is the fundamental environment where all features are installed and executed.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Configuration & Tooling
    subgraph "Configuration & Tooling"
        CT1[".devcontainer.json"]:::config
        CT2[".gic.yaml"]:::config
        CT3["makefile"]:::config
    end

    %% CI/CD Pipeline
    CICD["CI/CD Pipeline (GitHub Workflows)"]:::cicd

    %% DevContainer Base Image
    DCB["DevContainer Base Image (mcr.microsoft.com/devcontainers/base:ubuntu)"]:::container

    %% Feature Modules
    subgraph "Feature Modules"
        FM_Copa["copa"]:::feature
        FM_Crane["crane"]:::feature
        FM_Cyclonedx["cyclonedx"]:::feature
        FM_Flux["flux"]:::feature
        FM_Gic["gic"]:::feature
        FM_Gitleaks["gitleaks"]:::feature
        FM_Jnv["jnv"]:::feature
        FM_Kyverno["kyverno"]:::feature
        FM_Notation["notation"]:::feature
        FM_Ruff["ruff"]:::feature
        FM_Skopeo["skopeo"]:::feature
        FM_Uv["uv"]:::feature
        FM_Zarf["zarf"]:::feature
    end

    %% Test Suites
    subgraph "Test Suites"
        GT["Global Test Scripts (test/_global/)"]:::test
        subgraph "Individual Feature Tests"
            T_Copa["copa test"]:::test
            T_Crane["crane test"]:::test
            T_Cyclonedx["cyclonedx test"]:::test
            T_Flux["flux test"]:::test
            T_Gic["gic test"]:::test
            T_Gitleaks["gitleaks test"]:::test
            T_Jnv["jnv test"]:::test
            T_Kyverno["kyverno test"]:::test
            T_Notation["notation test"]:::test
            T_Ruff["ruff test"]:::test
            T_Skopeo["skopeo test"]:::test
            T_Uv["uv test"]:::test
            T_Zarf["zarf test"]:::test
        end
    end

    %% Relationships
    CT1 -->|"Configures"| DCB
    CT2 -->|"Configures"| DCB
    CT3 -->|"BuildAutomation"| DCB

    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Copa
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Crane
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Cyclonedx
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Flux
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Gic
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Gitleaks
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Jnv
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Kyverno
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Notation
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Ruff
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Skopeo
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Uv
    DCB -->|"Installationviainstall.sh&devcontainer-feature.json"| FM_Zarf

    FM_Copa -->|"Validationtest"| T_Copa
    FM_Crane -->|"Validationtest"| T_Crane
    FM_Cyclonedx -->|"Validationtest"| T_Cyclonedx
    FM_Flux -->|"Validationtest"| T_Flux
    FM_Gic -->|"Validationtest"| T_Gic
    FM_Gitleaks -->|"Validationtest"| T_Gitleaks
    FM_Jnv -->|"Validationtest"| T_Jnv
    FM_Kyverno -->|"Validationtest"| T_Kyverno
    FM_Notation -->|"Validationtest"| T_Notation
    FM_Ruff -->|"Validationtest"| T_Ruff
    FM_Skopeo -->|"Validationtest"| T_Skopeo
    FM_Uv -->|"Validationtest"| T_Uv
    FM_Zarf -->|"Validationtest"| T_Zarf

    CICD -->|"AutomationforBuild/Test/Release"| CT3
    CICD -->|"AutomationforBuild/Test/Release"| GT
    CICD -->|"CIIntegratesFeature"| FM_Flux
    CT1 --- CICD
    CICD --- DCB

    %% Styles
    classDef config fill:#f9f,stroke:#333,stroke-width:2px;
    classDef cicd fill:#ff9,stroke:#333,stroke-width:2px;
    classDef container fill:#9cf,stroke:#333,stroke-width:2px;
    classDef feature fill:#cfc,stroke:#333,stroke-width:2px;
    classDef test fill:#fcc,stroke:#333,stroke-width:2px;

    %% Click Events
    click CT1 "https://github.com/jsburckhardt/devcontainer-features/blob/main/.devcontainer.json"
    click CT2 "https://github.com/jsburckhardt/devcontainer-features/blob/main/.gic.yaml"
    click CT3 "https://github.com/jsburckhardt/devcontainer-features/tree/main/makefile"
    click DCB "https://github.com/jsburckhardt/devcontainer-features/blob/main/.devcontainer.json"

    click FM_Copa "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/copa/"
    click FM_Crane "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/crane/"
    click FM_Cyclonedx "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/cyclonedx/"
    click FM_Flux "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/flux/"
    click FM_Gic "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/gic/"
    click FM_Gitleaks "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/gitleaks/"
    click FM_Jnv "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/jnv/"
    click FM_Kyverno "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/kyverno/"
    click FM_Notation "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/notation/"
    click FM_Ruff "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/ruff/"
    click FM_Skopeo "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/skopeo/"
    click FM_Uv "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/uv/"
    click FM_Zarf "https://github.com/jsburckhardt/devcontainer-features/tree/main/src/zarf/"

    click CICD "https://github.com/jsburckhardt/devcontainer-features/tree/main/.github/workflows/"

    click GT "https://github.com/jsburckhardt/devcontainer-features/tree/main/test/_global/"

    click T_Copa "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/copa/test.sh"
    click T_Crane "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/crane/test.sh"
    click T_Cyclonedx "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/cyclonedx/test.sh"
    click T_Flux "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/flux/test.sh"
    click T_Gic "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/gic/test.sh"
    click T_Gitleaks "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/gitleaks/test.sh"
    click T_Jnv "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/jnv/test.sh"
    click T_Kyverno "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/kyverno/test.sh"
    click T_Notation "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/notation/test.sh"
    click T_Ruff "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/ruff/test.sh"
    click T_Skopeo "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/skopeo/test.sh"
    click T_Uv "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/uv/test.sh"
    click T_Zarf "https://github.com/jsburckhardt/devcontainer-features/blob/main/test/zarf/test.sh"
```
