Skip to content

Build Internal Operations

🛠️ Tools · ⬅ Home

Building markdown documentation

buildDocumentationBuild

Build the build documentation

Usage

buildDocumentationBuild [ --none ] [ --templates-only ] [ --templates ] [ --no-templates ] [ --derived ] [ --no-derived ] [ --derived-only ] [ --reference ] [ --no-reference ] [ --reference-only ] [ --mkdocs ] [ --no-mkdocs ] [ --mkdocs-only ] [ --see-update ] [ --index-update ] [ --docs-update ] [ --env-update ] [ --clean ] [ --verbose ] [ --filter filters ... ] [ --force ] [ --debug ]

Build the build documentation

Arguments

  • --none - Flag. Turn off all updates.
  • --templates-only - Flag. Just template identical updates.
  • --templates - Flag. Enable template updates.
  • --no-templates - Flag. Disable template updates.
  • --derived - Flag. Enable derived files updates.
  • --no-derived - Flag. Disable derived files updates.
  • --derived-only - Flag. Just derived files only.
  • --reference - Flag. Enable reference file updates.
  • --no-reference - Flag. Disable reference file updates.
  • --reference-only - Flag. Reference file updates.
  • --mkdocs - Flag. Enable mkdocs generation.
  • --no-mkdocs - Flag. Disable mkdocs generation.
  • --mkdocs-only - Flag. mkdocs generation only.
  • --see-update - Flag. SEE: token updates
  • --index-update - Flag. Update documentation indexes.`
  • --docs-update - Flag. Documentation generation only.
  • --env-update - Flag. Just update env document.
  • --clean - Flag. Clean caches.
  • --verbose - Flag. Clean caches.
  • --filter filters ... - DashDashDelimitedArguments. Arguments to filter which reference files are updated.
  • --force - Flag. Force building of everything.
  • --debug - Flag. Debugging output enabled.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Generating cache files

buildFunctionsDerivedCompile

Extract and build the documentation settings cache and generate derived

Usage

buildFunctionsDerivedCompile [ --clean ] [ --git ] [ --all ] [ --fingerprint ]

Extract and build the documentation settings cache and generate derived files

Arguments

  • --clean - Flag. Optional. Clean everything and then exit.
  • --git - Flag. Optional. Do some handy git changes. (Adding/removing files)
  • --all - Flag. Optional. Do everything regardless of cache state.
  • --fingerprint - Flag. Optional. Use fingerprint to ensure results are up to date.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildFunctionsCompile

Extract and build the documentation settings cache

Usage

buildFunctionsCompile [ --clean ] [ --git ] [ --all ] [ --derive command ... -- ] [ --help ]

Extract and build the documentation settings cache

Arguments

  • --clean - Flag. Optional. Clean everything and then exit.
  • --git - Flag. Optional. Do some handy git changes. (Adding/removing files)
  • --all - Flag. Optional. Do everything regardless of cache state.
  • --derive command ... -- - CommandList. Optional. Run this command on each changed settings file to generate derived files.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildFunctionsCompileParallel

Experimental: Compile usage using multiple processes and a writer and

Usage

buildFunctionsCompileParallel [ --help ] [ --handler handler ] [ --workers workerCount ] [ --all ] [ --clean ]

Experimental: Compile usage using multiple processes and a writer and several readers.

Arguments

  • --help - Flag. Optional. Display this help.
  • --handler handler - Function. Optional. Use this error handler instead of the default error handler.
  • --workers workerCount - PositiveInteger. Optional. Create this many workers to do the job.
  • --all - Flag. Optional. Check and build all of the build functions usage data.
  • --clean - Flag. Optional. Delete all usage files before starting.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildToolsCompile

Experimental - resulting file ends up being around 1MB

Usage

buildToolsCompile

Experimental - resulting file ends up being around 1MB

Arguments

  • none

Examples

timing executeCount 100 source bin/build/tools.sh ; timing executeCount 100 source bin/build/tools-compiled.sh
executeCount 100 source bin/build/tools.sh 8.628 seconds
executeCount 100 source bin/build/tools-compiled.sh 7.728 seconds

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Deployment

buildStepInitialize

Build step check

Usage

buildStepInitialize [ dumpEnv ]

Run at the start of build steps to check that the environment exists and dump it, optionally using a build flag passed as the first argument. Check if .build.env exists and dump the environment if true passed

Arguments

  • dumpEnv - Boolean. Optional. When true dumps the environment.

Return codes

  • 1 - .build.env is missing
  • 0 - All is well

Development

repairProfile

Run repair on profile-related tokens

Usage

repairProfile

Run repair on profile-related tokens

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildPreRelease

undocumented

Usage

buildPreRelease

No documentation for buildPreRelease.

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildAddTool

undocumented

Usage

buildAddTool [ name ]

No documentation for buildAddTool.

Arguments

  • name - String. Optional. Name of tool to add.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildPR

Zesk Build open a URL with a new PR

Usage

buildPR

Zesk Build open a URL with a new PR

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Testing Wrappers

buildTestPlatforms

Run Zesk Build tests on multiple platforms

Usage

buildTestPlatforms [ --env-file envFile ]

Run Zesk Build tests on multiple platforms

Arguments

  • --env-file envFile - File. Optional. Environment file to load - can handle any format.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildTestSuite

Run Zesk Build tests

Usage

buildTestSuite

Run Zesk Build tests

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildTestSuiteIndex

Generate ./test/tests.index for Zesk Build

Usage

buildTestSuiteIndex

Generate ./test/tests.index for Zesk Build

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildQuickTest

Run tests (and continue from last failure point) but skip

Usage

buildQuickTest

Run tests (and continue from last failure point) but skip slow and package installation tests.

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildStagingTest

Run tests (and continue from last failure point)

Usage

buildStagingTest

Run tests (and continue from last failure point) Do not do housekeeper or plumber by default. (faster)

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildProductionTest

Run production tests

Usage

buildProductionTest [ ... ]

Run production tests

Arguments

  • ... - Arguments. Optional. Passed to testSuite.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildBuildTiming

Test build timings with different settings

Usage

buildBuildTiming

Test build timings with different settings

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

buildContainer

Load Zesk Build in a preconfigured container

Usage

buildContainer [ image ]

Load Zesk Build in a preconfigured container Starts in /root/build Loads .STAGING.env first

Arguments

  • image - String. Optional. Image to load

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

🛠️ Tools · ⬅ Top