Skip to content

Configuring Yontrack for GitHub

In this section, we'll see how to configure Yontrack for GitHub workflows.

Don't forget to check the Configuration as Code section to see how to configure Yontrack using CasC.

Yontrack needs to be able to access the GitHub API. Create the GitHub token with the following permissions:

  • repo
  • read:user, user:email

Create a secret in the same namespace as Yontrack with the name yontrack-github and with the value of the GitHub token in the token key.

In your Yontrack Casc files, define:

ontrack:
  config:
    github:
      name: github
      url: https://github.com
      oauth2Token: {{ secrets.yontrack-github.token }}

In the Helm chart values for your Yontrack installation, declare this secret:

ontrack:
  casc:
    secrets:
      mapping: file
      names:
        - yontrack-github

When Yontrack is restarted, it will be able to access the GitHub API. You can check this by navigating to your user menu at Configurations > GitHub configurations. You should see the GitHub configuration you just created and you can test it by using the button.

Dispatching workflows

The auto-versioning post-processing and the GitHub workflow notifications dispatch GitHub workflows, and Yontrack follows the run each dispatch creates.

GitHub returns this run in its answer to the dispatch. When it does not, like on an older GitHub Enterprise Server (Yontrack dispatches again without asking for the run if GitHub rejects the request), Yontrack searches for the run using an id input it passes to the workflow, which the workflow uploads as an artifact.

The workflowSendId field of the GitHub configuration (also in CasC, Send workflow ID in the form) says whether this id input is sent. It is false by default, and each auto-versioning post-processing configuration and each notification can override it with its own sendId field. A configuration created before Yontrack 6 keeps true, unless it is defined as code: see Migration to V6.

GitHub rejects a dispatch whose inputs do not match the inputs declared by the workflow:

Workflow declares id (required) Workflow does not declare id
id is sent OK Rejected
id is not sent Rejected OK

Set it to true only on a GitHub which does not return the run of a dispatch, for workflows which declare id: without the id input, a run which is not returned cannot be searched for, and the dispatch fails.