Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/pre-pr-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ limitations under the License.
-->
# Before you ask for a merge

Seven commands, all host-side, none needing a device or a build. Every one of them answers a question that
Eight commands, all host-side, none needing a device or a build. Every one of them answers a question that
`mergeable=true`, a green CI tick and a careful read of your own diff do not.

Run them from the repository root on the branch you are about to hand over.
Expand All @@ -29,6 +29,7 @@ below says why.
| command | red means |
|---|---|
| `python3 tools/copyright.py --check` | a file has no notice, or has two |
| `python3 tools/ci/notice_covers_deps.py --check` | a dependency that is fetched and compiled into the binary is not named in `NOTICE` |
| `python3 tools/ci/tests_referenced_check.py` | a test, tool self-test or python test exists that nothing runs |
| `python3 tools/ci/ci_targets_check.py --check` | a CI row names a target or path that does not exist |
| `python3 tools/ci/registration_loss_check.py --check --base origin/main` | your branch would drop rows `main` has |
Expand Down
3 changes: 3 additions & 0 deletions scripts/pre-pr-checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ git rev-parse --verify -q "$base^{commit}" >/dev/null || {
# that need a revision last.
checks=(
"tools/copyright.py --check"
# engine#2344: NOTICE is hand-maintained, so a dependency compiled into the binary can arrive with no
# licence line; this is the check that caught it. Registered as a ctest row but not run here until now.
"tools/ci/notice_covers_deps.py --check"
"tools/ci/tests_referenced_check.py"
"tools/ci/ci_targets_check.py --check"
"tools/ci/tmp_path_check.py --check"
Expand Down
Loading