Keycloak GitHub Bot

GitHub Application to help manage issues and PRs for the Keycloak project.

The bot is currently deployed to https://openshift-console.osci.io/.

What the application does

Add area labels to bug reports

The bug issue form for the Keycloak project has a dropdown for selecting the affected area. The bot will automatically add the applicable area/ when a new bug issue is created.

Remove status/triage label when an issue is closed

When an issue is closed the status/triage label is removed from the issue.

Link backport PRs to issues

When a PR targeting release/* is opened, edited, or reopened, the bot adds it to the Development section of issues referenced by closing keywords in its description, such as Closes #123. References can use #123, owner/repo#123, or https://github.com/owner/repo/issues/123, but must identify issues in the PR's repository. Linking works for open and closed issues without requiring backport labels.

Testing changes to the application

To test changes to the application you need:

• Create a testing GitHub Application
• Install the above into a testing repository on GitHub
• A smee.io channel to receive webhooks from GitHub locally
• A .env file in the repository

Example .env file:

QUARKUS_GITHUB_APP_APP_ID=123456
QUARKUS_GITHUB_APP_APP_NAME=Keycloak Bot Testing
QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL=https://smee.io/1234256
QUARKUS_GITHUB_APP_WEBHOOK_SECRET=12346
QUARKUS_GITHUB_APP_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\
1234256789\
-----END RSA PRIVATE KEY-----

When the above has been done you can run the application locally using:

./mvnw compile quarkus:dev

Related Guides

• GitHub App (guide): Automate GitHub tasks with a GitHub App