GitHub App

A GitHub App is a tool that extends GitHub’s functionality. It can do things on GitHub like open issues, comment on pull requests, manage projects, etc.

Learn more about GitHub Apps.

Why do we use a GitHub App?

The Red Hat Konflux GitHub App integrates GitHub events (e.g., Push to a branch, Pull Request, etc.) with the Pipelines As Code (PAC) component. The App allows Konflux to perform actions based on your configuration in the .tekton folder and integrate Konflux updates into your project.

What does the App do?

The App provides several key functionalities to enhance your development workflow.

Some of the features:

  • Initializes Tekton on-pull/on-push PipelineRuns definition during installation

  • Runs Tekton PipelineRuns on your pull requests

  • Tekton PipelineRuns can be run through comments (e.g., /ok-to-test, /retest)

  • Creates pull requests containing Konflux updates

Where is the App installed?

A GitHub App is installed on a specific repository or an entire organization. Users can manage and configure the app’s settings through the repository or organization’s settings page under Installed GitHub Apps.

Install the App only into git repositories that are onboarded to Konflux. Do not install the App organization-wide unless all repositories are onboarded to Konflux.
When migrating Componentes between Konflux clusters, don’t forget to uninstall the App which corresponds to the old cluster.