Merge pull request #2069 from tweag/cg/refactor_ci_workflow

mergify[bot] · web-flow · commit d0caba34fa34 · 2023-12-06T15:26:28.000Z
chore: refactor CI workflow
diff --git a/.github/actions/authenticate_github_api/action.yaml b/.github/actions/authenticate_github_api/action.yaml
@@ -0,0 +1,21 @@
+name: Authenticate with GitHub API
+description: |
+  Authenticated GitHub API requests are not rate-limited like unauthenticated requests.
+
+# For more details: https://github.com/tweag/rules_haskell/pull/1494
+
+inputs:
+  github_token:
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - shell: bash
+      env:
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        cat >~/.netrc <<EOF
+        machine api.github.com
+                password ${GITHUB_TOKEN}
+        EOF
diff --git a/.github/actions/free_disk_space_on_linux/action.yaml b/.github/actions/free_disk_space_on_linux/action.yaml
@@ -0,0 +1,14 @@
+name: Free Disk Space on Linux
+description: Remove unneeded files from the Ubuntu GitHub runner.
+
+runs:
+  using: composite
+  steps:
+    - shell: bash
+      if: ${{ runner.os == 'Linux' }}
+      run: |-
+        sudo swapoff -a
+        sudo rm -rf /swapfile /usr/share/dotnet /usr/local/lib/android /opt/ghc
+        docker rmi $(docker images -q) -f
+
+
diff --git a/.github/actions/install_apt_pkgs/action.yaml b/.github/actions/install_apt_pkgs/action.yaml
@@ -0,0 +1,19 @@
+name: Install Apt Packages
+description: Install packages via apt-get install.
+
+inputs:
+  packages:
+    type: string
+    description: A space-separated list of apt packages to install.
+
+runs:
+  using: composite
+  steps:
+    - shell: bash
+      if: ${{ runner.os == 'Linux' }}
+      env:
+        APT_PACKAGES: ${{ inputs.packages }}
+      run: |-
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends -yy "${APT_PACKAGES}"
+        sudo apt clean
diff --git a/.github/actions/set_tcp_keepalive_time/action.yaml b/.github/actions/set_tcp_keepalive_time/action.yaml
@@ -0,0 +1,21 @@
+name: Set the TCP keep-alive time
+description: Avoids deadline exceeded errors on Linux.
+
+# Avoid failures of the form `deadline exceeded after 14999958197ns DEADLINE_EXCEEDED`.
+# See https://github.com/tweag/rules_haskell/issues/1498 and https://github.com/tweag/rules_haskell/pull/1692.
+
+inputs:
+  tcp_keepalive_time:
+    type: number
+    description: The value to be set for the TCP keep-alive time.
+    default: 60
+
+runs:
+  using: composite
+  steps:
+    - shell: bash
+      if: ${{ runner.os == 'Linux' }}
+      env:
+        TCP_KEEPALIVE_TIME: ${{ inputs.tcp_keepalive_time }}
+      run: |-
+        sudo sysctl -w "net.ipv4.tcp_keepalive_time=${TCP_KEEPALIVE_TIME}"
diff --git a/.github/workflows/workflow.yaml b/.github/workflows/workflow.yaml
@@ -24,18 +24,15 @@ jobs:
         with:
           buildbuddy_api_key: ${{ secrets.BUILDBUDDY_API_KEY }}
           bazelrc_path: .bazelrc.auth
+      - uses: ./.github/actions/set_tcp_keepalive_time
+      - uses: ./.github/actions/authenticate_github_api
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
       - name: Configure
         run: |
-          # Avoid failures of the form `deadline exceeded after 14999958197ns DEADLINE_EXCEEDED`.
-          # See https://github.com/tweag/rules_haskell/issues/1498 and https://github.com/tweag/rules_haskell/pull/1692.
-          [[ ${{ runner.os }} == Linux ]] && sudo sysctl -w net.ipv4.tcp_keepalive_time=60
           cat >>.bazelrc.local <<EOF
           common --config=ci
           EOF
-          cat >~/.netrc <<EOF
-          machine api.github.com
-                  password ${{ secrets.GITHUB_TOKEN }}
-          EOF
       - run: |
           bazelisk test buildifier:buildifier_test
 
@@ -64,12 +61,8 @@ jobs:
             bzlmod: true
     runs-on: ${{ matrix.os }}
     steps:
-      - if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: |-
-          sudo swapoff -a
-          sudo rm -rf /swapfile /usr/share/dotnet /usr/local/lib/android /opt/ghc
-          docker rmi $(docker images -q) -f
       - uses: actions/checkout@v4
+      - uses: ./.github/actions/free_disk_space_on_linux
       - name: Mount Bazel cache
         uses: actions/cache@v3
         with:
@@ -85,11 +78,12 @@ jobs:
         with:
           buildbuddy_api_key: ${{ secrets.BUILDBUDDY_API_KEY }}
           bazelrc_path: .bazelrc.auth
+      - uses: ./.github/actions/set_tcp_keepalive_time
+      - uses: ./.github/actions/authenticate_github_api
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
       - name: Configure
         run: |
-          # Avoid failures of the form `deadline exceeded after 14999958197ns DEADLINE_EXCEEDED`.
-          # See https://github.com/tweag/rules_haskell/issues/1498 and https://github.com/tweag/rules_haskell/pull/1692.
-          [[ ${{ runner.os }} == Linux ]] && sudo sysctl -w net.ipv4.tcp_keepalive_time=60
           case ${{ runner.os }} in
             macOS) BUILD_CONFIG=ci-macos-nixpkgs;;
             Linux) BUILD_CONFIG=ci-linux-nixpkgs;;
@@ -101,10 +95,6 @@ jobs:
           EOF
           cp .bazelrc.local rules_haskell_nix
           cp .bazelrc.local rules_haskell_tests
-          cat >~/.netrc <<EOF
-          machine api.github.com
-                  password ${{ secrets.GITHUB_TOKEN }}
-          EOF
       - name: Check Bazel version
         run: |
           nix-shell --arg docTools false --argstr ghcVersion ${{ matrix.ghc }} --pure --run .ci/check-bazel-version
@@ -175,15 +165,11 @@ jobs:
       GHC_VERSION: ${{ matrix.ghc }}
     runs-on: ${{ matrix.os }}
     steps:
-      - if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: |-
-          sudo swapoff -a
-          sudo rm -rf /swapfile /usr/share/dotnet /usr/local/lib/android /opt/ghc
-          sudo apt-get update
-          sudo apt-get install --no-install-recommends -yy libtinfo5
-          sudo apt clean
-          docker rmi $(docker images -q) -f
       - uses: actions/checkout@v4
+      - uses: ./.github/actions/free_disk_space_on_linux
+      - uses: ./.github/actions/install_apt_pkgs
+        with: 
+          packages: libtinfo5
       - name: Mount Bazel cache
         uses: actions/cache@v3
         with:
@@ -199,12 +185,13 @@ jobs:
         with:
           buildbuddy_api_key: ${{ secrets.BUILDBUDDY_API_KEY }}
           bazelrc_path: .bazelrc.auth
+      - uses: ./.github/actions/set_tcp_keepalive_time
+      - uses: ./.github/actions/authenticate_github_api
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
       - name: Configure
         shell: bash
         run: |
-          # Avoid failures of the form `deadline exceeded after 14999958197ns DEADLINE_EXCEEDED`.
-          # See https://github.com/tweag/rules_haskell/issues/1498 and https://github.com/tweag/rules_haskell/pull/1692.
-          [[ ${{ runner.os }} == Linux ]] && sudo sysctl -w net.ipv4.tcp_keepalive_time=60
           case "${{ runner.os }},${{ matrix.module }}" in
             macOS,*) BUILD_CONFIG=ci-macos-bindist;;
             Linux,*) BUILD_CONFIG=ci-linux-bindist;;
@@ -232,33 +219,21 @@ jobs:
           common --enable_bzlmod=${{ matrix.bzlmod }}
           EOF
           cp .bazelrc.local rules_haskell_tests
-          cat >~/.netrc <<EOF
-          machine api.github.com
-                  password ${{ secrets.GITHUB_TOKEN }}
-          EOF
       - name: Build & test - rules_haskell
         if: matrix.module == 'rules_haskell'
         shell: bash
         run: |
-          if [[ ${{ runner.os }} == Windows ]]; then
-            # On Windows `//...` expands to `/...`.
-            bazel test ///...
-          else
-            bazel test //...
-          fi
+          # Quote the package specifier so that it works on Windows
+          bazel test "//..."
 
       - name: Build & test - rules_haskell_tests
         if: matrix.module == 'rules_haskell_tests'
         shell: bash
         run: |
           cd rules_haskell_tests
           ./tests/run-start-script.sh --use-bindists --with-bzlmod=${{ matrix.bzlmod }}
-          if [[ ${{ runner.os }} == Windows ]]; then
-            # On Windows `//...` expands to `/...`.
-            bazel test ///...
-          else
-            bazel test //...
-          fi
+          # Quote the package specifier so that it works on Windows
+          bazel test "//..."
           # Test stack_snapshot pinning
           # NOTE keep in sync with tests/RunTests.hs
           bazel run @stackage-pinning-test-unpinned//:pin
