GitHub Actions is used to automate parts of our development workflow.
See https://docs.github.com/en/actions for more information.
We run checks on all Pull Requests (PRs). We recommend that when appropriate, developers run the following scripts before submitting a PR.
Alternately, you may run the actions on your fork of Anki-Android.
| Job | Command | Comments |
|---|---|---|
| Lint (Kotlin) | ./gradlew lintPlayDebug :api:lintDebug :libanki:lintDebug ktLintCheck lintVitalFullRelease lint-rules:test --daemon |
Android lint rules, formatting and tests for lint rules |
| Lint (JavaScript) | See script | Prettier, lint & code formatting |
| Unit Tests | ./gradlew jacocoUnitTestReport --daemon |
Unit tests for the Android Project |
| Emulator Tests | ./gradlew jacocoAndroidTestReport --daemon |
Emulator tests for the Android Project |
| CodeQL | N/A | GitHub-only check. Docs |
These are typically run by maintainers. See the Maintenance guide