Skip to content

GitHub Workflow (github-workflow)

This channel is used to trigger remote GItHub Actions workflows with some inputs.

Note

This channel does not use the custom template.

Configuration

  • callMode - ASYNC, SYNC - required - How to call the Workflow. ASYNC (the default) means that the job is called in "fire and forget" mode. When set to SYNC, Yontrack will wait for the completion of the job to success, with a given timeout (not recommended).

  • config - String - required - Name of the GitHub configuration to use for the connection.

  • inputs - List - required - Inputs to send to to the workflow dispatch

    • name - String - required - name field

    • value - String - required - value field

  • owner - String - required - Repository owner for the workflow

  • reference - String - required - Git reference (branch, tag or commit SHA) for the workflow

  • repository - String - required - Repository name for the workflow

  • sendId - Boolean - optional - If defined, overrides the GitHub configuration for passing the id input to the workflow, used to find its run when GitHub does not return it

  • timeoutSeconds - Int - required - Timeout in seconds

  • workflowId - String - required - Workflow ID (like main.yml)

Output

  • inputs - List - required - Inputs to send to to the workflow dispatch

    • name - String - required - name field

    • value - String - required - value field

  • owner - String - required - Repository owner for the workflow

  • reference - String - required - Git reference (branch, tag or commit SHA) for the workflow

  • repository - String - required - Repository name for the workflow

  • url - String - required - URL of the GitHub instance

  • workflowId - String - required - Workflow ID (like main.yml)

  • workflowRunId - Long - optional - Workflow run ID, will be filled in only if the workflow is actually launched