@rxap/plugin-docker

This plugin provides executors and generators for building and saving Docker images within an Nx workspace. It simplifies the process of creating Dockerfiles, building images, and pushing them to registries, as well as saving images to archives. It also includes generators for configuring projects and generating GitLab CI pipelines for Docker-based applications.

• Installation
• Generators
  • config
  • gitlab-ci
  • init
• Executors
  • build
  • save

Installation

Add the package to your workspace:

yarn add @rxap/plugin-docker

Execute the init generator:

yarn nx g @rxap/plugin-docker:init

Execute the config generator to use the package with a project:

yarn nx g @rxap/plugin-docker:config [project]

Generators

config

Add the executor 'docker' to the selected project and add generic depend on rules to nx.json

nx g @rxap/plugin-docker:config

Option	Type	Default	Description
project	string		The name of the project to add the Docker build executor to.
context	string		The build context path for the Docker build process.
dockerfile	string		The path to the Dockerfile relative to the project root.
buildTarget	string		The build target from which to extract the output path.
imageSuffix	string		A suffix to add to the base Docker image name.
imageName	string		The base name of the Docker image.
imageRegistry	string		The Docker image registry URL.
command	string		The custom command to start the Docker container.
save	boolean		Whether to create a 'save' target in the project configuration.
overwrite	boolean		Whether to overwrite existing files during configuration.

gitlab-ci

gitlab-ci generator

nx g @rxap/plugin-docker:gitlab-ci

Option	Type	Default	Description
gcp	boolean		Whether to generate a Docker startup test that pulls from the GCP registry.
gitlab	boolean		Whether to generate a Docker startup test that pulls from the GitLab registry.
overwrite	boolean		Whether to overwrite existing GitLab CI configuration files.
skipFormat	boolean	false	Whether to skip formatting files with Prettier after generation.
tags	array		The list of project tags to filter for Docker configuration.

init

Initialize the package in the workspace

nx g @rxap/plugin-docker:init

Option	Type	Default	Description
skipFormat	boolean	false	Whether to skip formatting files with Prettier after initialization.

Executors

build

Executes the docker build command with the context set to the build output folder

Option	Type	Default	Description
context	string		The docker build context path
dockerfile	string		The path to the dockerfile
tag	array		A list of docker image tags
buildTarget	string		The target from witch the output path can be extract.
imageSuffix	string		A suffix added to the base image name
imageName	string		The base image name
imageRegistry	string		The image registry
command	string	docker	The command to start docker
latest	boolean	false	If true a destination with a latest tag is added
push	boolean	false	If true all created images are pushed
buildArgList	array

save

Executes the docker save command for the latest image created with the build command

Option	Type	Default	Description
outputPath	string		output path for the tar.gz files
imageSuffix	string		A suffix added to the base image name
imageName	string		The base image name