How docker/actions-toolkit works
Actions Toolkit is a reusable library for Docker GitHub Actions, providing shared action utilities and wrappers around Docker build tooling. The principal workflow is an action author using the toolkit to prepare or invoke build tools and interact with GitHub Actions; the repository also covers image handling, signing and verification, and supporting developer utilities. The README documents the product scope, while sampled imports establish only some internal links; unsampled modules are represented without inferred call chains.
Main entry points: exec.ts Process execution · buildx.ts Buildx operations · docker.ts Docker client · github.ts GitHub integration
Components 24
Toolkit API
- Toolkit facade
src/toolkit.ts - Package exports
src/index.ts
Build tooling
- Buildx operations
src/buildx/buildx.ts - Bake orchestration
src/buildx/bake.ts - BuildKit Git
src/buildkit/git.ts - BuildKit protocol types
src/types/buildkit/client.ts
Docker and images
- Docker client
src/docker/docker.ts - Docker setup
src/docker/install.ts - Compose setup
src/compose/install.ts - Image tools
src/buildx/imagetools.ts - OCI models
src/oci/oci.ts - Registry client
src/regclient/regctl.ts - Image unpacking
src/undock/undock.ts
Signing and trust
- Cosign setup
src/cosign/install.ts - Cosign client
src/cosign/cosign.ts - Sigstore verification
src/sigstore/sigstore.ts
Action support
- GitHub integration
src/github/github.ts - Tool and image cache
src/cache.ts - Temporary workspace
src/context.ts - Process execution
src/exec.ts - Git utilities
src/git.ts - Shared utilities
src/util.ts - Runner and bake helpers
src/github-builder
Other components
- Docker action
Connections 38
- Docker action → Toolkit facade: uses library
- Toolkit facade → Package exports: exposes API
- Buildx operations → Docker client: checks availability
src/buildx/buildx.ts - Buildx operations → BuildKit Git: uses Git support
src/buildx/buildx.ts - Buildx operations → GitHub integration: creates annotations
src/buildx/buildx.ts - Buildx operations → Process execution: runs commands
src/buildx/buildx.ts - Buildx operations → BuildKit protocol types: uses status types
src/buildx/buildx.ts - Bake orchestration → Buildx operations: uses Buildx
src/buildx/bake.ts - Bake orchestration → Temporary workspace: uses workspace
src/buildx/bake.ts - Bake orchestration → Process execution: runs commands
src/buildx/bake.ts - Docker client → Tool and image cache: caches images
src/docker/docker.ts - Docker client → Process execution: runs commands
src/docker/docker.ts - Docker client → Temporary workspace: uses workspace
src/docker/docker.ts - Docker setup → Docker client: configures daemon
src/docker/install.ts - Docker setup → GitHub integration: fetches releases
src/docker/install.ts - Docker setup → Registry client: reads manifests
src/docker/install.ts - Docker setup → Image unpacking: uses unpacker
src/docker/install.ts - Docker setup → Process execution: starts services
src/docker/install.ts - Compose setup → Tool and image cache: uses cache
src/compose/install.ts - Compose setup → Temporary workspace: uses workspace
src/compose/install.ts - Compose setup → Docker client: checks Docker
src/compose/install.ts - Compose setup → GitHub integration: fetches releases
src/compose/install.ts - Image tools → Buildx operations: uses Buildx
src/buildx/imagetools.ts - Image tools → Temporary workspace: uses workspace
src/buildx/imagetools.ts - Image tools → Process execution: runs commands
src/buildx/imagetools.ts - Registry client → Process execution: runs commands
src/regclient/regctl.ts - Image unpacking → Process execution: runs commands
src/undock/undock.ts - Cosign setup → Buildx operations: checks builder
src/cosign/install.ts - Cosign setup → Tool and image cache: caches binary
src/cosign/install.ts - Cosign setup → Sigstore verification: uses Sigstore
src/cosign/install.ts - Cosign client → Process execution: runs commands
src/cosign/cosign.ts - Sigstore verification → Cosign client: checks availability
src/sigstore/sigstore.ts - Sigstore verification → Image tools: uses image tools
src/sigstore/sigstore.ts - Sigstore verification → Process execution: runs commands
src/sigstore/sigstore.ts - Sigstore verification → GitHub integration: uses GitHub APIs
src/sigstore/sigstore.ts - GitHub integration → Docker action: calls GitHub
- Git utilities → Process execution: runs commands
src/git.ts - Git utilities → GitHub integration: uses GitHub
src/git.ts