Explain rationale for using main branch of downstream package

trixi-framework · Nov 6, 2023 · 6d1ee66 · 6d1ee66
1 parent 0f8ab3e
commit 6d1ee66
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/.github/workflows/downstream.yml b/.github/workflows/downstream.yml
@@ -71,6 +71,9 @@ jobs:
       - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - name: Retrieve downstream package
+        # Note: we retrieve the current `main` branch of the downstream package to ensure
+        # that compatibility errors we make in Trixi.jl are detected already here
+        # See also https://github.com/trixi-framework/Trixi.jl/pull/1707#discussion_r1382938895
         uses: actions/checkout@v4
         with:
           repository: trixi-framework/${{ matrix.package }}