gistfile1.txt

<p>
    Execute <a href="https://www.updatecli.io/updatecli" target="_blank">updatecli</a> on the repository.

    <p>
    The following arguments are available for this function:
    <ul>
      <li>String action: (Optional - Default: "diff") Updatecli action (e.g. subcommand) to execute.</li>
      <li>String config: (Optional - Default: "./updatecli/updatecli.d") path to the file or directory with the updatecli configuration (flag "--config").</li>
      <li>String values: (Optional - Default: "./updatecli/values.yaml") path to the file with the updatecli values (flag "--values").</li>
      <li>String updatecliDockerImage: (Optional - Default: "ghcr.io/updatecli/updatecli:latest") Docker Image of updatecli to be used in the process.</li>
    </ul>

    Examples:

    <pre><code>
    // Run the "updatecli diff" command
    updatecli()
    </code></pre>

    <pre><code>
    // updatecli can use the environment variable "UPDATECLI_GITHUB_TOKEN" as a token source to allow GitHub access (both API reads and PR creation)
    withCredentials([string(credentialsId: 'github-credential-with-write-access', variable: 'UPDATECLI_GITHUB_TOKEN')]) {
      updatecli(
        // Run the "updatecli apply" command
        action: "apply"
        // Configuration of updatecli is stored in the file "updateci.yaml" at the repository's root
        config: "./updateci.yaml",
        // No values flag to be passed
        values: "",
      )
    }
    </code></pre>


    </p>
</p>

<!--
vim: ft=html
-->