Skip to content

Commit bc33c3e

Browse files
committed
Mention how to configure license/tasks checks
1 parent 53a6809 commit bc33c3e

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

Diff for: README.md

+41-2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,45 @@ 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+
The bot can be configured to check that the pull request body includes the license agreement text from the template.
39+
To enable the check, add the following to the repository configuration:
40+
41+
```yaml
42+
---
43+
licenseAgreement:
44+
enabled: true
45+
# Optionally provide the pattern to use for extracting the license text from the `PULL_REQUEST_TEMPLATE.md`
46+
# Keep in mind that the bot expects that the license text to check is matched by the 1st group:
47+
pullRequestTemplatePattern: .+(---.+---).++
48+
```
49+
50+
### Pull request tasks
51+
52+
The bot can also add a list of tasks to the pull request as a reminder of the steps to complete before
53+
the pull request can be merged. This can be enabled per repository. Once enabled, the list of tasks per
54+
issue type should be configured. If the Jira issue type doesn't have a list of tasks configured the generic tasks will be used.
55+
56+
```yaml
57+
---
58+
pullRequestTasks:
59+
# Make the bot add list of tasks to the pull requests and enable the check that makes sure all tasks are completed:
60+
enabled: true
61+
# List of tasks for commits without a Jira ID
62+
# or for those with Jira ID but that don't have a specific configuration for a corresponding issue type:
63+
genericTasks:
64+
- task1
65+
- task2
66+
# Issue type specific tasks:
67+
tasks:
68+
bug:
69+
- bug task1
70+
- bug task2
71+
improvement:
72+
- improvement task1
73+
```
74+
3675
## Configuration
3776
3877
### Enabling the bot in a new repository
@@ -106,9 +145,9 @@ develocity:
106145

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

109-
You will need admin rights in the Hibernate organization.
148+
You will need admin rights in the Hibernate organization and access to the OpenShift cluster.
110149

111-
The infrastructure configuration can be found [here](https://github.com/hibernate/ci.hibernate.org).
150+
The infrastructure configuration can be found [here](src/main/resources/application.properties) under "#Deployment configuration".
112151

113152
The GitHub registration of this bot can be found [here](https://github.com/organizations/hibernate/settings/apps/hibernate-github-bot).
114153

0 commit comments

Comments
 (0)