YAML for Gitcrypt lock

View as Markdown

Lock files in the repository using git-crypt encryption.

YAML parameters for Gitcrypt lock

PARAMETERS

keysrequiredBinaryFileYaml[]

Key names you want to use to lock your repository

typerequiredstring

Value: GIT_CRYPT_LOCK

actionrequiredstring

Unique identifier for the action within the pipeline.

force_argboolean

Set to true if you want to lock even if there is uncommitted work in pipeline filesystem

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

loopstring[]

The list of variables for dynamic action execution. The action runs once for each value.

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.

disabledboolean

When set to true the action is disabled. By default it is set to false.

timeoutinteger

The timeout in seconds.

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.

retry_intervalinteger

Delay time between auto retries in seconds.

retry_countinteger

Number of retries if the action fails.

run_nextstring enum

Defines whether the action should run in parallel with the next one.

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

trigger_conditionsTriggerConditionYaml[]

The list of trigger conditions to meet so that the action can be triggered.

variablesVariableYaml[]

The list of variables you can use in the action.

Last modified on Jul 31, 2025

Git Push Gitcrypt unlock

YAML examples for Gitcrypt lock

Lock repository with git-crypt

yaml
  - action: "Git Crypt Lock"
    type: "GIT_CRYPT_LOCK"
    force_arg: true
    keys:
      - name: "symmetric.key"
        content: "!encrypted base64-encoded-key-content"

Simple git-crypt lock

yaml
  - action: "Lock repository"
    type: "GIT_CRYPT_LOCK"