⚙️ Parameters

This document lists all available settings for Forge, Docker, and Node.js build processes. All parameters can be passed to the build system as NUKE parameters (command-line arguments, e.g. --param value). These can also be set via environment variables or in the .build.env.map configuration file, depending on your CI/CD setup.

---

🛠️ Forge (Common Settings)

These are the base parameters available to all builds. NodeParams and DockerParams both inherit from ForgeParams, so all settings below are available to Node and Docker builds as well.

Environment

Variable	Description	Default
RepositoryUrl	The URL of the source code repository.
Notifications	Enable/disable notifications (bool).	false
ForceNotifications	Force notifications even if not required (bool).	false
NotificationsWebHookUrl	Webhook URL for sending notifications.
ForcePush	Force push actions (bool).	false
DryRun	Run the build in dry-run mode (bool).	false
Verbosity	Verbosity level for build output (enum).	Normal

NUKE Parameters

Variable	Description	Default
--repository-url	The URL of the source code repository.
--notifications	Enable/disable notifications (bool).	false
--force-notifications	Force notifications even if not required (bool).	false
--notifications-web-hook-url	Webhook URL for sending notifications.
--force-push	Force push actions (bool).	false
--dry-run	Run the build in dry-run mode (bool).	false
--verbosity	Verbosity level for build output (enum).	Normal

---

🐳 Docker

Inherits all settings from Forge.

Environment

Variable	Description	Default
TemplatesDir	Directory path for Dockerfile templates.	/nuke/templates
Dockerfile	Path to the Dockerfile.	Dockerfile
ImageTag	Tag for the container image.	container-app
RegistryUrl	Registry URL for pushing the Docker image.
RegistryUser	Registry user name.
RegistryToken	Registry authentication token.
CreateGitHubRelease	Whether to create a GitHub release after build (bool).	false

NUKE Parameters

Parameter	Description	Default
--templates-dir	Directory path for Dockerfile templates.	/nuke/templates
--docker-file	Path to the Dockerfile.	Dockerfile
--image-tag	Tag for the container image.	container-app
--registry-url	Registry URL for pushing the Docker image.
--registry-user	Registry user name.
--registry-token	Registry authentication token.
--create-github-release	Whether to create a GitHub release after build (bool).	false

---

🟩 Node.js

Inherits all settings from Forge.

Environment

Variable	Description	Default
ArtifactsDir	Directory path for storing build artifacts.	artifacts

NUKE Parameters

Parameter	Description	Default
--artifacts-dir	Directory path for storing build artifacts.	artifacts

Example

Tell the build process to create a GitHub release (false by default):

Create .build.env.map, with:

CreateGitHubRelease=const:true

Use a NUKE parameter:

& docker run `
     -e DOCKER_HOST=tcp://host.docker.internal:2375 `
     -v ./:/workspace `
     -it ghcr.io/the-running-dev/build-agent:latest `
     docker-build --create-github-release true