Skip to content

Commit 8dba0f5

Browse files
committed
Mention how to configure license/tasks checks
1 parent ff127af commit 8dba0f5

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ links to JIRA tickets will be appended at the bottom of the PR body.
3333
Optionally, the bot can be configured to automatically create a GitHub check listing Develocity build scans
3434
for every commit that has completed checks related to CI (GitHub Actions or Jenkins).
3535

36+
### License agreement check
37+
38+
Optionally, the bot can be configured to check that the pull request body includes the license agreement text from the template.
39+
40+
### Pull request tasks
41+
42+
Optionally, the bot can also add a list of tasks to the pull request as a reminder of the steps to complete before
43+
the pull request can be merged. This can be enabled per repository. Once enabled, the list of tasks per
44+
issue type should be configured. If the Jira issue type doesn't have a list of tasks configured the default tasks will be used.
45+
3646
## Configuration
3747

3848
### Enabling the bot in a new repository
@@ -100,15 +110,37 @@ develocity:
100110
replacement: "$0"
101111
- pattern: "hibernate.search|elasticsearch|opensearch|main|\\d+.\\d+|PR-\\d+"
102112
replacement: "" # Just remove these tags
113+
licenseAgreement:
114+
enabled: true
115+
# Optionally provide the pattern to use for extracting the license text from the `PULL_REQUEST_TEMPLATE.md`
116+
# Keep in mind that the bot expects that the license text to check is matched by the 1st group:
117+
pullRequestTemplatePattern: .+(---.+---).+
118+
pullRequestTasks:
119+
# Make the bot add list of tasks to the pull requests and enable the check that makes sure all tasks are completed:
120+
enabled: true
121+
# Tasks for a particular issue type, with `default` being a "unique" category:
122+
tasks:
123+
# List of tasks for commits without a Jira ID
124+
# or for those with Jira ID but that don't have a specific configuration for a corresponding issue type:
125+
default:
126+
- task1
127+
- task2
128+
# Tasks specific to the bug issue type:
129+
bug:
130+
- bug task1
131+
- bug task2
132+
# Tasks specific to the improvement issue type:
133+
improvement:
134+
- improvement task1
103135
```
104136
105137
### Altering the infrastructure
106138
107139
This should only be needed very rarely, so think twice before trying this.
108140
109-
You will need admin rights in the Hibernate organization.
141+
You will need admin rights in the Hibernate organization and access to the OpenShift cluster.
110142
111-
The infrastructure configuration can be found [here](https://github.com/hibernate/ci.hibernate.org).
143+
The infrastructure configuration can be found [here](src/main/resources/application.properties) under "#Deployment configuration".
112144
113145
The GitHub registration of this bot can be found [here](https://github.com/organizations/hibernate/settings/apps/hibernate-github-bot).
114146

0 commit comments

Comments
 (0)