File: Recommended-pre-push-hook.md

package info (click to toggle)
firefox 147.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,320 kB
  • sloc: cpp: 7,607,359; javascript: 6,533,295; ansic: 3,775,223; python: 1,415,500; xml: 634,561; asm: 438,949; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (30 lines) | stat: -rw-r--r-- 954 bytes parent folder | download | duplicates (12) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# Recommended pre-push hook

If you want to reduce your PR turn-around time, I'd recommend adding a
pre-push hook: this script will stop a push if the unit tests or linters
fail, finding the failures before it hits TaskCluster (which takes
forever to dig through the logs):
```sh
#!/bin/sh

./gradlew -q \
        checkstyle \
        ktlint \
        pmd \
        detektCheck \
        app:assembleFocusArmDebug


# Tasks omitted because they take a long time to run:
# - unit test on all variants
# - UI tests
# - lint (compiles all variants)
```

To use it:
1. Create a file with these ^ contents (exclude the "\`") at `<repo>/.git/hooks/pre-push`
1. Make it executable: `chmod 755 <repo>/.git/hooks/pre-push`

And it will run before pushes. Notes:
- Run `git push ... --no-verify` to push without making the check
- It takes ~30 seconds to run. If you think this hook takes too long, you can remove the unit test line and it becomes almost instant.