Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.56 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.56 KB
Raw

Hibernate GitHub Bot

Powered by

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.

Features

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.

Configuration

Enabling the bot in a new repository

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 features as well, create the file .github/hibernate-github-bot.yml in default branch of your repository, will the following content:

---
jira:
  projectKey: "HSEARCH" # Change to whatever your project key is

Altering the infrastructure

This should only be needed very rarely, so think twice before trying this.

You will need admin rights in the Hibernate organization.

The infrastructure configuration can be found here.

The GitHub registration of this bot can be found here.

Contributing

Development and testing

Always test your changes locally before pushing them.

You can run the bot locally by:

  1. Registering a test instance of the GitHub application on a fake, "playground" repository as explained here.
  2. Adding an .env file at the root of the repository, as explained here.
  3. Running ./mvnw quarkus:dev.

Deployment

The main branch is automatically deployed in production through this Jenkins job, configured through the Jenkinsfile at the root of this repository.