This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, visit its website: https://quarkus.io/.
Specifically, most of the GitHub-related features in this bot are powered by
the quarkus-github-app extension.
This bot checks various contribution rules on pull requests submitted to Hibernate projects on GitHub, and notifies the pull request authors of any change they need to work on.
This includes:
- Basic formatting of the pull request: at least two words in the title, ...
- Proper referencing of related JIRA tickets: the ticket key must be mentioned in the PR description.
- Proper formatting of commits: every commit message must start with the key of a JIRA ticket.
- Etc.
Optionally, the bot can be configured to automatically add links to JIRA issues in PR descriptions. When this is enabled links to JIRA tickets will be appended at the bottom of the PR body.
Optionally, the bot can be configured to automatically create a GitHub check listing Develocity build scans for every commit that has completed checks related to CI (GitHub Actions or Jenkins).
Optionally, the bot can be configured to check that the pull request body includes the license agreement text from the template.
Optionally, the bot can also add a list of tasks to the pull request as a reminder of the steps to complete before the pull request can be merged. This can be enabled per repository. Once enabled, the list of tasks per issue type should be configured. If the Jira issue type doesn't have a list of tasks configured the default tasks will be used.
You will need admin rights in the Hibernate organization.
Go to the installed application settings and add your repository under "Repository access".
If you wish to enable the JIRA-related or Develocity-related features as well,
create the file .github/hibernate-github-bot.yml in default branch of your repository,
with the following content:
---
jira:
projectKey: "HSEARCH" # Change to whatever your project key is
insertLinksInPullRequests: true # This is optional and enables automatically adding links to Jira issues found in a PR's commits to its description
linkIssuesLimit: 3 # This is optional and allows disabling automatic issue links when more than the specified number of keys are found in a PR's commits (defaults to 3)
# To skip JIRA-related checks (pull request title/body includes JIRA issue keys/links etc.),
# a list of ignore rules can be configured:
ignore:
- user: dependabot[bot]
titlePattern: ".*\\bmaven\\b.*\\bplugin\\b.*" # will ignore build dependency upgrades i.e. maven plugin version upgrades.
- user: all-contributors[bot]
titlePattern: ".*"
# To skip commits that contain only irrelevant files for JIRA-related checks (commit includes JIRA issue key),
# a list of ignored files rules can be configured:
ignoreFiles:
# Ignore a directory recursively
- ".github"
- "ci"
- "build/config"
# Ignore a specific file
- "Jenkinsfile"
# Ignore all paths matching a given pattern
- "*/Jenkinsfile"
- "*.Jenkinsfile"
develocity:
buildScan:
# To have the bot create a GitHub check listing Develocity build scans
# for every commit that has completed checks related to CI (GitHub Actions or Jenkins)
addCheck: true
# To group tags in a separate column and/or alter/remove some tags,
# a list of column rules can be configured:
tags:
- column: "OS"
pattern: "Linux"
- column: "OS" # Multiple rules can target the same column
pattern: "Windows.*"
replacement: "Windows"
- column: "Java"
pattern: "jdk-(.*)"
replacement: "$1"
- column: "Backend"
pattern: "elasticsearch-(.*)"
replacement: "es-$1" # Replacement can refer to capture groups
- column: "Backend"
pattern: "(.*-)?opensearch-(.*)"
replacement: "$1os-$2"
- column: "Backend"
pattern: "lucene"
- column: "DB"
pattern: "h2|postgres|postgres(ql)?|mysql|mssql|derby|tidb|cockroach(db)?|oracle.*|db2"
replacement: "$0"
- pattern: "hibernate.search|elasticsearch|opensearch|main|\\d+.\\d+|PR-\\d+"
replacement: "" # Just remove these tags
licenseAgreement:
enabled: true
# Optionally provide the pattern to use for extracting the license text from the `PULL_REQUEST_TEMPLATE.md`
# Keep in mind that the bot expects that the license text to check is matched by the 1st group:
pullRequestTemplatePattern: .+(---.+---).+
pullRequestTasks:
# Make the bot add list of tasks to the pull requests and enable the check that makes sure all tasks are completed:
enabled: true
# Tasks for a particular issue type, with `default` being a "unique" category:
tasks:
# List of tasks for commits without a Jira ID
# or for those with Jira ID but that don't have a specific configuration for a corresponding issue type:
default:
- task1
- task2
# Tasks specific to the bug issue type:
bug:
- bug task1
- bug task2
# Tasks specific to the improvement issue type:
improvement:
- improvement task1This should only be needed very rarely, so think twice before trying this.
You will need admin rights in the Hibernate organization and access to the OpenShift cluster.
The infrastructure configuration can be found here under "#Deployment configuration".
The GitHub registration of this bot can be found here.
Development and testing
Always test your changes locally before pushing them.
You can run the bot locally by:
- Registering a test instance of the GitHub application on a fake, "playground" repository as explained here.
- Adding an
.envfile at the root of the repository, as explained here. - Running
./mvnw quarkus:dev.
Just push to the main branch.
The main branch is automatically deployed in production through
this GitHub action. The app is pushed to an OpenShift cluster.
Maintainers can review the application, check the current health and update configuration/secrets on the OpenShift console.
Link to the console: https://console-openshift-console.apps.ospo-osci.z3b1.p1.openshiftapps.com/k8s/cluster/projects/prod-hibernate-infra
TODO: document this someday... See https://github.com/quarkusio/search.quarkus.io/blob/main/README.adoc#setting-it-up
