Padawan Pipeline Variables
This table defines all the variables Padawan can read from your project's Gitlab CI/CD pipeline variables found under Settings→CI/CD→Variables.
Variable | Default Value | Valid Values | Protected? | Masked? | Description |
---|---|---|---|---|---|
BUILD_OUTPUT_DIR | dist | (string) | yes | no | The directory of the site to deploy. For example, React projects should use BUILD_OUTPUT_DIR=build since build is the default React output directory. |
CYPRESS_SCREENSHOTS_PATH | cypress/screenshots | (string) | yes | no | For pipelines that have an E2E test step, such as npm pipeline, you can modify this value to specify where Cypress stores screenshot artifacts. The path should match the screenshotsFolder variable in your repo's cypress.config.js |
CYPRESS_VIDEOS_PATH | cypress/videos | (string) | yes | no | For pipelines that have an E2E test step, such as npm pipeline, you can modify this value to specify where Cypress stores video artifacts. The path should match the videosFolder variable in your repo's cypress.config.js |
DEBUG | 0 | 1 or 0 | yes | no | See extended console outputs of pipeline jobs (when value is 1). |
DEPENDENCY_CHECK_EXTRA_ARGS | --failOnCVSS 7.6 | (string) | yes | no | Extra arguments to pass to the dependency check job. See https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html for more information. |
E2E_TARGET | source | source or staging | yes | no | For pipelines that have an E2E test step, such as npm pipeline, you can modify this value to change where the E2E test step is run. More information can be found in recommended-gitlab-config |
FORCE_DOWNLOAD_DEPENDENCIES | false | true or false | yes | no | Forces download of dependencies instead of relying on the cache. |
HUGO_IMAGE_VERSION | registry.dso.mil/ironbank/opensource/gohugo/hugo-extended:v0.123.0 | (string) | yes | no | For hugo pipelines, this determines the docker image used to run the build job |
NODE_IMAGE_VERSION | registry1.dso.mil/ironbank/opensource/nodejs/nodejs18:18.17.1 | (string) | yes | no | For npm pipelines, this determines the docker image used to run jobs (npm-install , build , unit-test , etc.) |
PADAWAN_DEPLOYMENT_BRANCH | master | (string) | yes | no | Only referenced if PADAWAN_DEPLOYMENT_TYPE=branch . When changes happen on this branch the deployment pipeline will be triggered. |
PADAWAN_DEPLOYMENT_TIMEOUT | 300 | (int) | yes | no | Default value: 300 seconds (5 minutes). Minimum value: 15 seconds. Maximum value: 900 seconds (15 minutes). This timeout determines how long to continue checking whether the new site version has been deployed yet. |
PADAWAN_DEPLOYMENT_TYPE | tag | tag or branch | yes | no | The mechanism you want to use for deployment. Can be either tag or branch. If tag, repo tags that match the semver "v0.0.1" or "0.0.1" will enable the deployment pipeline. If branch, branches that match PADAWAN_DEPLOYMENT_BRANCH will enable the deployment pipeline. |
PADAWAN_PRODUCTION_CONTROL_GATE | true | true or false | yes | no | Determines if a manual control gate step should be in the pipeline before deploying to the production environment. Values: true or false. |
PADAWAN_STAGING_CONTROL_GATE | false | true or false | yes | no | Determines if a manual control gate step should be in the pipeline before deploying to the staging environment. Values: true or false. |
REQUIRE_IL2_SSO | false | true or false | yes | no | To deploy sites in IL2 Padawan Public or SSO. If true, then deploy in IL2 Padawan SSO. |
SKIP_DEPENDENCY_CHECK | true | true or false | yes | no | An open source tool that will check used libraries for known vulnerabilities. See https://owasp.org/www-project-dependency-check/ for more information. Disabled by default. |
SKIP_E2E_TEST | false | true or false | yes | no | For pipelines that have an end-to-end test step, such as the npm pipeline, you can optionally skip the E2E tests. |
SKIP_LINT | false | true or false | yes | no | For pipelines that have a lint step, such as the npm pipeline, you can optionally skip linting. |
SKIP_UNIT_TEST | false | true or false | yes | no | For pipelines that have a unit test step, such as the npm pipeline, you can optionally skip unit tests. |
SKIP_VALE | true | true or false | yes | no | The optional https://vale.sh prose linter (see Vale), disabled by default. |