|
8 | 8 |
|
9 | 9 | To verify compilation locally, run `./gradlew build` or try running JabRef.
|
10 | 10 |
|
11 |
| -- jobName: 'Unit tests' |
| 11 | +- jobName: 'Unit tests - jablib' |
12 | 12 | message: >
|
13 |
| - JUnit tests are failing. |
14 |
| - In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". |
15 |
| - This brings you to the test output. |
| 13 | + JUnit tests of `jablib` are failing. |
| 14 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 15 | + To see the test output, locate "Tests / Unit tests (pull_request)" and click on it. |
| 16 | +
|
| 17 | +
|
| 18 | + You can then run these tests in IntelliJ to reproduce the failing tests locally. |
| 19 | + We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide. |
| 20 | +- jobName: 'Unit tests - jabkit' |
| 21 | + message: > |
| 22 | + JUnit tests of `jabkit` are failing. |
| 23 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 24 | + To see the test output, locate "Tests / Unit tests (pull_request)" and click on it. |
| 25 | +
|
| 26 | +
|
| 27 | + You can then run these tests in IntelliJ to reproduce the failing tests locally. |
| 28 | + We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide. |
| 29 | +- jobName: 'Unit tests - jabsrv' |
| 30 | + message: > |
| 31 | + JUnit tests of `jabsrv` are failing. |
| 32 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 33 | + To see the test output, locate "Tests / Unit tests (pull_request)" and click on it. |
16 | 34 |
|
17 | 35 |
|
18 | 36 | You can then run these tests in IntelliJ to reproduce the failing tests locally.
|
|
21 | 39 | message: >
|
22 | 40 | Your code currently does not meet [JabRef's code guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html).
|
23 | 41 | We use [Checkstyle](https://checkstyle.sourceforge.io/) to identify issues.
|
24 |
| - Please carefully follow [the setup guide for the codestyle](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html). |
25 |
| - Afterwards, please [run checkstyle locally](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#run-checkstyle) and fix the issues. |
| 42 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 43 | + To see the test output, locate "Tests / Checkstyle (pull_request)" and click on it. |
26 | 44 |
|
27 | 45 |
|
28 | 46 | In case of issues with the import order, double check that you [activated Auto Import](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#enable-proper-import-cleanup).
|
29 | 47 | You can trigger fixing imports by pressing <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>O</kbd> to trigger [Optimize Imports](https://www.jetbrains.com/guide/tips/optimize-imports/).
|
| 48 | +
|
| 49 | +
|
| 50 | + Please carefully follow [the setup guide for the codestyle](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html). |
| 51 | + Afterwards, please [run checkstyle locally](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#run-checkstyle) and fix the issues, commit, and push. |
30 | 52 | - jobName: OpenRewrite
|
31 | 53 | message: >
|
32 | 54 | Your code currently does not meet JabRef's code guidelines.
|
33 | 55 | We use [OpenRewrite](https://docs.openrewrite.org/) to ensure "modern" Java coding practices.
|
34 |
| - The issues found can be **automatically fixed**. |
35 |
| - Please execute the gradle task *`rewriteRun`*, check the results, commit, and push. |
| 56 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 57 | + To see the test output, locate "Tests / OpenRewrite (pull_request)" and click on it. |
36 | 58 |
|
37 | 59 |
|
38 |
| - You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite". |
| 60 | + The issues found can be **automatically fixed**. |
| 61 | + Please execute the gradle task *`rewriteRun`* from the [`rewrite` group of the Gradle Tool window](https://devdocs.jabref.org/code-howtos/faq.html#failing-openrewrite-tests) in IntelliJ, then check the results, commit, and push. |
39 | 62 | - jobName: Modernizer
|
40 | 63 | message: >
|
41 | 64 | Your code currently does not meet JabRef's code guidelines.
|
42 | 65 | We use [Gradle Modernizer Plugin](https://github.com/andygoossens/gradle-modernizer-plugin#gradle-modernizer-plugin) to ensure "modern" Java coding practices.
|
43 |
| - Please fix the detected errors, commit, and push. |
44 |
| -
|
| 66 | + You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. |
| 67 | + To see the test output, locate "Tests / Modernizer (pull_request)" and click on it. |
45 | 68 |
|
46 |
| - You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Modernizer". |
47 | 69 |
|
| 70 | + Please fix the detected errors, commit, and push. |
48 | 71 |
|
49 | 72 | # CHANGELOG.md and *.md
|
50 | 73 |
|
|
83 | 106 | - jobName: no-force-push
|
84 | 107 | always: true
|
85 | 108 | message: >
|
86 |
| - Do not force-push! |
87 |
| - Force pushing is a very bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)). |
| 109 | + Hey, we noticed that you **force-pushed** your changes. |
| 110 | + Force pushing is a bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)). |
88 | 111 | Commits are lost and comments on commits lose their context, thus making it harder to review changes.
|
89 | 112 | At the end, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) anyway before being merged into the `main` branch.
|
| 113 | +
|
| 114 | +
|
| 115 | + In future, **please avoid that**. For now, you can continue working. |
90 | 116 | - jobName: 'Conflicts with target branch'
|
91 | 117 | message: >
|
92 | 118 | Your pull request conflicts with the target branch.
|
|
106 | 132 |
|
107 | 133 | # PR text
|
108 | 134 |
|
| 135 | +- jobName: 'Mandatory Checks present' |
| 136 | + always: true |
| 137 | + message: > |
| 138 | + You have removed the "Mandatory Checks" section from your pull request description. Please adhere to our [pull request template](https://github.com/JabRef/jabref/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L10). |
109 | 139 | - jobName: 'PR checklist OK'
|
110 | 140 | always: true
|
111 | 141 | message: >
|
112 |
| - Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and mark them as one of `[x] done`, `[ ] not done (yet)`, `[/] not applicable`. |
113 |
| -- jobName: 'Determine issue number' |
| 142 | + Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of `[x]` (done), `[ ]` (not done yet) or `[/]` (not applicable). |
| 143 | +- jobName: 'Issue number present' |
114 | 144 | always: true
|
115 | 145 | message: |
|
116 | 146 | Your pull request needs to link an issue.
|
|
0 commit comments