PushDashboards

Commit and push your saved dashboards to a Git repository.

yaml
type: "io.kestra.plugin.git.PushDashboards"

Manually push a single dashboard to Git if the input push is set to true.

yaml
id: push_dashboards
namespace: prod

inputs:
  - id: push
    type: BOOLEAN
    defaults: false

tasks:
  - id: if
    type: io.kestra.plugin.core.flow.If
    condition: "{{ inputs.push == true}}"
    then:
      - id: commit_and_push
        type: io.kestra.plugin.git.PushDashboards
        dashboards: mydashboard # if you prefer templating, you can use "{{ flow.id }}"
        url: https://github.com/kestra-io/scripts
        username: git_username
        password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
        branch: main
        commitMessage: "add mydashboard from {{ flow.namespace ~ '.' ~ flow.id }}"

Dynamic YES

The commit author email.

If null, no author will be set on this commit.

Dynamic YES

Default `username`

The commit author name.

If null, the username will be used instead.

Dynamic YES

Default main

The branch to which dashboards should be committed and pushed.

Dynamic NO

Whether to clone submodules.

Dynamic YES

Default Add dashboards from flow: {{ flow.id }}

Git commit message.

Dynamic YES

Default **

List of glob patterns or a single one that declares which dashboards should be included in the Git commit.

Dynamic NO

Default false

If true, the task will only output modifications without pushing any file to Git yet. If false (default), all listed files will be pushed to Git immediately.

Dynamic YES

Default _dashboards

Directory to which dashboards should be pushed.

Dynamic YES

The passphrase for the privateKey.

Dynamic YES

The password or Personal Access Token (PAT). When you authenticate the task with a PAT, any flows or files pushed to Git from Kestra will be pushed from the user associated with that PAT. This way, you don't need to configure the commit author (the authorName and authorEmail properties).

Dynamic YES

PEM-format private key content that is paired with a public key registered on Git.

To generate an ECDSA PEM format key from OpenSSH, use the following command: ssh-keygen -t ecdsa -b 256 -m PEM. You can then set this property with your private key content and put your public key on Git.

Dynamic YES

The URI to clone from.

Dynamic YES

The username or organization.

​Push​Dashboards

PushDashboards