Skip to content

Commit

Permalink
Added a useful reference to the README template
Browse files Browse the repository at this point in the history
  • Loading branch information
neboskreb committed Sep 11, 2024
1 parent 0a5c122 commit 680fdba
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md.template
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,35 @@ At this time, Google hasn't shared any immediate plans to bring first-party supp
- [Add support for JUnit 5 (issuetracker.google.com)](https://issuetracker.google.com/issues/127100532)
- [JUnit 5 support (github.com/android/android-test)](https://github.com/android/android-test/issues/224)

## Support for @Rules
Since JUnit 5 has replaced the `@Rule` mechanism with Extensions, the following artifacts help bridge the gap until Android officially transitions to JUnit 5.

### InstantExecutorExtension

Replaces `InstantTaskExecutorRule` in JUnit 5.

<details>
<summary>Kotlin</summary>

```kotlin
dependencies {
testImplementation("${libs.instantTaskExecutorExtension}")
}
```
</details>

<details>
<summary>Groovy</summary>

```groovy
dependencies {
testImplementation '${libs.instantTaskExecutorExtension}'
}
```
</details>

For more details see [instant-task-executor-extension](https://github.com/neboskreb/instant-task-executor-extension) on GitHub.

## Building Locally

This repository contains multiple modules, divided into two sub-projects. The repository's root directory contains build logic shared across the sub-projects, which in turn use symlinks to connect to the common build scripts in their parent folder.
Expand Down
4 changes: 4 additions & 0 deletions build-logic/src/main/kotlin/Dependencies.kt
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,8 @@ object libs {
const val composeUiTest = "androidx.compose.ui:ui-test"
const val composeUiTestJUnit4 = "androidx.compose.ui:ui-test-junit4"
const val composeUiTestManifest = "androidx.compose.ui:ui-test-manifest"

// Documentation
// For the latest version refer to GitHub repo neboskreb/instant-task-executor-extension
const val instantTaskExecutorExtension = "io.github.neboskreb:instant-task-executor-extension:1.0.0"
}

0 comments on commit 680fdba

Please sign in to comment.