Shell

“changedif” defines how Updatecli interprets the result of the shell command.

In Updatecli, a success means nothing changed, a warning means something changed, and an error means something went wrong.

compatible:

• source
• condition
• target

default: console/output

remark:

• accepted kinds are “console/output”, “exitcode” and “file/checksum”.
• “console/output” checks the command output. In a target, any output on stdout means something changed, otherwise nothing changed.
• “exitcode” checks the command exit code.
• “file/checksum” checks the checksum of files before and after the command.

example:

  targets:
    default:
      name: 'doc: synchronize release note'
      kind: 'shell'
      disablesourceinput: true
      spec:
        command: 'releasepost --dry-run="$DRY_RUN" --config {{ .config }} --clean'
        environments:
          - name: 'GITHUB_TOKEN'
          - name: 'PATH'
        changedif:
          kind: 'exitcode'
          spec:
            warning: 0
            success: 1
            failure: 2

  targets:
    default:
      disablesourceinput: true
      name: Example of a shell command with a checksum success criteria
      kind: shell
      spec:
        command: |
          yq -i '.a.b[0].c = "cool"' file.yaml
        changedif:
          kind: file/checksum
          spec:
            files:
              - file.yaml

“command” defines the shell command to run.

compatible:

• source
• condition
• target

remark:

• “command” is required.
• in a condition or a target, the source output is appended to the command as its last argument. The two following snippets are equivalent:

  targets:
    default:
      name: Example 2
      kind: shell
      sourceid: default
      spec:
        command: 'echo'

  targets:
    default:
      name: Example 2
      kind: shell
      disablesourceinput: true
      spec:
        command: 'echo {{ source "default"}}'

“environments” defines the environment variables passed to the shell command.

compatible:

• source
• condition
• target

default: depends on the operating system:

• Windows: PATH, PSModulePath, PSModuleAnalysisCachePath, PATHEXT, TEMP, HOME, USERPROFILE, PROFILE
• Darwin/Linux: PATH, HOME, USER, LOGNAME, SHELL, LANG, LC_ALL

remark:

• for security reasons, Updatecli does not pass its whole environment to the shell command. It uses an allow list of environment variables instead.
• “DRY_RUN” is reserved and set by Updatecli, so it cannot be defined.
• “UPDATECLI_PIPELINE_STAGE” is set by Updatecli to the current stage.

example:

• environments:
  • name: PATH
  • name: GITHUB_TOKEN

“name” defines the environment variable name.

remark:

• “name” is required.

“value” defines the environment variable value.

default: the value of the same variable in the Updatecli process environment.

remark:

• when “value” is unset and the Updatecli process does not define the variable, an error is logged and the variable is passed with an empty value.

“shell” defines the shell interpreter used to run the command.

compatible:

• source
• condition
• target

default: depends on the operating system:

• Windows: “powershell.exe -executionpolicy remotesigned -File”
• Darwin/Linux: “/bin/sh”

“workdir” defines the working directory from where the command runs.

compatible:

• source
• condition
• target

default: the scm checkout directory, or the manifest directory when no scm is set.

remark:

• a relative path is joined to the default directory.
• an absolute path is used as is.