Update README + Add comments to build.yml

Tribler · Feb 19, 2024 · a7e16cd · a7e16cd
1 parent 853a427
commit a7e16cd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,7 +8,8 @@ on:
 jobs:
   test:
     name: Run Tests
-    runs-on: windows-latest # TODO: Ubuntu currently broken.
+    # TODO: Ubuntu currently broken.
+    runs-on: windows-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -21,6 +22,10 @@ jobs:
           distribution: 'zulu'
           java-version: '17'
 
+      # TODO: This is currently broken due to SqlDelight.
+      #      - name: Run check
+      #        run: bash ./gradlew check
+
       - name: Run tests
         run: bash ./gradlew test
 

diff --git a/README.md b/README.md
@@ -135,6 +135,7 @@ Run unit tests:
 ```
 ./gradlew test
 ```
+*Note: Currently tests fail on Linux, but pass on Windows and Mac. This is due to the tests relying on a native jlibtorrent binary, of which the linux version cannot be bundled with android builds. We are working on a solution to this problem.*
 
 Run instrumented tests:
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -135,6 +135,7 @@ Run unit tests: @@
     ```
     ./gradlew test
     ```
+    *Note: Currently tests fail on Linux, but pass on Windows and Mac. This is due to the tests relying on a native jlibtorrent binary, of which the linux version cannot be bundled with android builds. We are working on a solution to this problem.*
     Run instrumented tests:
     ```
@@ Expand Down @@