Forge
Plugins

GitLab

Plugin for GitLab CI/CD integration

@bjb-forge/nx-gitlab-project

Installation

pnpm exec forge add @bjb-forge/nx-gitlab-project

Plugin Options

{
  "plugin": "@bjb-forge/nx-gitlab-project/nx-plugin",
  "options": {}
}
OptionTypeDescription
platform.programstringName of your platform program (only small letters and numbers)
localPluginsbooleanWhether you declare local Nx plugins in your repository (will trigger a 'tsc --build' before the build)
ci.imagestringImage to be used for your CI runner. Defaults to forge images- use only after agreeing with TechX team.
ci.verbosebooleanRun the CI in verbose mode by setting NX_VERBOSE_LOGGING to true
ci.cachebooleanWhether to keep Nx cache or not
ci.affectedbooleanWhether to only build affected projects (true) or all projects (false)
ci.executionstringControls whether CI tasks run in parallel (single nx command with all targets) or in series (one nx command per target)
ci.workersnumberNumber of parallel workers to use for nx commands (adds --parallel=N)
ci.unbufferbooleanWhether to unbuffer the output of CI commands
ci.releaseobjectRelease settings

Inferred Targets

sync-gitlab-ci-yml

Synchronizes the GitLab CI/CD pipeline configuration based on workspace structure.

Condition: When .gitlab/workflows/.gitlab-ci.yml exists

deploy

Applies the preview environment XRDs to the cluster via pew create. Invoked by the child pipeline matrix; runs once per affected preview project.

Condition: When env/pre/preview.yaml exists

nx-release-publish

Appends this preview project's matrix entry to .gitlab/workflows/.gitlab-cd.yml so the parent pipeline's preview trigger job can spawn the deploy child pipeline.

Condition: When env/pre/preview.yaml exists

On this page