Skip to content

Commit

Permalink
Upd README
Browse files Browse the repository at this point in the history
  • Loading branch information
igorwojda committed Nov 17, 2023
1 parent ed8e4a8 commit 6fb201c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
distribution: 'zulu'

- name: konsist
run: ./gradlew konsist_test:test
run: ./gradlew konsist_test:test --rerun-tasks

- uses: actions/upload-artifact@v3
with:
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,17 +303,20 @@ the [.github/workflows](.github/workflows) folder.

### Pull Request Verification

Series of workflows run (in parallel) for every opened PR and after merging PR to the `main` branch:
Series of workflows run (in parallel) for every opened PR, and after merging PR to the `main` branch:

* `./gradlew konsist_test:test --rerun-tasks` - checks that source code satisfies Konsist rules
* `./gradlew lintDebug` - checks that source code satisfies Android lint rules
* `./gradlew detektCheck` - checks that sourcecode satisfies detekt rules
* `./gradlew detektApply` - applies detekt code formatting rules to sourcecode in-place
* `./gradlew spotlessCheck` - checks that source code satisfies formatting steps.
* `./gradlew spotlessApply` - applies code formatting steps to the source code in place.
* `./gradlew testDebugUnitTest` - run unit tests
* `./gradlew connectedCheck` - run UI tests
* `./gradlew :app:bundleDebug` - create an application bundle

The following tasks cab be executed locally to make codebase compliant with the rules:
* `./gradlew detektApply` - applies detekt code formatting rules to sourcecode in-place
* `./gradlew spotlessApply` - applies code formatting steps to the source code in place.

## Design Decisions

Read related articles to have a better understanding of underlying design decisions and various trade-offs.
Expand Down

0 comments on commit 6fb201c

Please sign in to comment.