.github/workflows/build.yaml (1)

52-52: Document the required label format in workflow comments

The conditional execution based on the 'binary:' label is a good approach for manual control. However, it would be helpful to document the exact label format required to trigger the binary builds.

Add a comment above the job to explain the label requirement:

+    # Requires a label starting with 'binary:' to trigger the binary builds
+    # Example: binary:all, binary:hoprd, etc.
     if: contains(github.event.pull_request.labels.*.name, 'binary:')

.github/workflows/build-binaries.yaml (1)

Line range hint 98-101: Fix incorrect condition for Nix installation.

The condition still references the removed runner_needs_nix_setup input.

Apply this fix:

- if: inputs.runner_needs_nix_setup == true
+ if: env.GH_RUNNER_NEEDS_NIX_SETUP == 'true'

🧰 Tools

🪛 actionlint (1.7.4)

62-62: shellcheck reported issue in this script: SC1075:error:20:3: Use 'elif' instead of 'else if' (or put 'if' on new line if nesting)

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1009:info:20:3: The mentioned syntax error was in this else clause

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1046:error:20:8: Couldn't find 'fi' for this 'if'

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1073:error:20:8: Couldn't parse this if expression. Fix to allow more checks

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1075:error:23:3: Use 'elif' instead of 'else if' (or put 'if' on new line if nesting)

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1047:error:27:1: Expected 'fi' matching previously mentioned 'if'

(shellcheck)

---

62-62: shellcheck reported issue in this script: SC1072:error:27:2: Unexpected keyword/token. Fix any mentioned problems and try again

(shellcheck)

---

62-62: property "test_id" is not defined in object type {binary: string; runner: string; target: string}

(expression)

---

98-98: property "runner_needs_nix_setup" is not defined in object type {binary: string; branch: string; runner: string; target: string}

(expression)

Configuration used: .coderabbit.yaml
Review profile: CHILL

#!/bin/bash
# Description: Check runner labels and recent workflow runs to verify architecture support

# Check recent workflow runs for these runners
gh run list --workflow=build.yaml --json conclusion,name,headBranch,status --jq '.[] | select(.name | contains("build-binaries")) | {name: .name, conclusion: .conclusion, branch: .headBranch}' --limit 10

# List available runner labels
gh api repos/$GITHUB_REPOSITORY/actions/runners --jq '.runners[] | {name: .name, labels: .labels[].name}'

#!/bin/bash
# Let's verify the workflow configuration and runner usage patterns

# Check the workflow file content
cat .github/workflows/build.yaml

# Search for any related workflow files that might reference these runners
fd -e yaml -e yml . .github/workflows/ --exec grep -l "runner:"

# Look for any documentation about runners
fd README -t f | xargs grep -l "runner" || true

#!/bin/bash
# Let's check the build-binaries workflow to understand runner requirements
cat .github/workflows/build-binaries.yaml

# Also check if there are any recent changes to runner configurations
fd -e yaml -e yml . .github/workflows/ --exec grep -A 5 -B 5 "runner:"

.github/workflows/build-binaries.yaml (1)

Line range hint 98-106: Fix the Nix setup condition.

The condition still references the removed input runner_needs_nix_setup. It should use the environment variable instead.

Apply this fix:

-        if: inputs.runner_needs_nix_setup == true
+        if: env.GH_RUNNER_NEEDS_NIX_SETUP == 'true'

Configuration used: .coderabbit.yaml
Review profile: CHILL

Configuration used: .coderabbit.yaml
Review profile: CHILL

.github/workflows/build-binaries.yaml (2)

23-49: Enhance input descriptions for better clarity.

The workflow_dispatch configuration is well-structured, but consider these improvements:

1. The runner description only mentions macOS options but includes self-hosted-hoprnet-bigger
2. The binary options (hoprd and hopli) would benefit from descriptions explaining their purpose

       binary:
         required: true
-        description: 'Binary to build'
+        description: 'Binary to build (hoprd: HOPR node daemon, hopli: HOPR command-line interface)'
         type: choice
         options:
           - hoprd
           - hopli
       runner:
         type: choice
         options:
           - self-hosted-hoprnet-bigger
           - macos-13
           - macos-14
         required: true
-        description: 'GH Runner to use: macos-13=x86_64-darwin and macos-14=aarch64-darwin'
+        description: 'GH Runner to use: self-hosted=Linux builds, macos-13=x86_64-darwin, macos-14=aarch64-darwin'

---

Line range hint 108-116: Fix Nix installation condition.

The Nix installation step is still using the removed input runner_needs_nix_setup. It should use the environment variable instead.

       - name: Install Nix
-        if: inputs.runner_needs_nix_setup == true
+        if: env.GH_RUNNER_NEEDS_NIX_SETUP == 'true'
         uses: cachix/install-nix-action@v29
         with:
           github_access_token: ${{ secrets.GITHUB_TOKEN }}
           nix_path: nixpkgs=channel:nixos-24.05

       - uses: cachix/cachix-action@v15
-        if: env.GH_RUNNER_NEEDS_NIX_SETUP == true
+        if: env.GH_RUNNER_NEEDS_NIX_SETUP == 'true'

Configuration used: .coderabbit.yaml
Review profile: CHILL

.github/workflows/build-binaries.yaml (1)

Line range hint 110-117: Fix inconsistent Nix setup conditions.

The conditions for Nix setup are inconsistent:

• Install Nix step uses inputs.runner_needs_nix_setup
• Cachix step uses env.GH_RUNNER_NEEDS_NIX_SETUP

This could lead to unexpected behavior where Nix is installed but Cachix is not configured, or vice versa.

Apply this fix:

-      - name: Install Nix
-        if: inputs.runner_needs_nix_setup == true
+      - name: Install Nix
+        if: env.GH_RUNNER_NEEDS_NIX_SETUP == 'true'

Configuration used: .coderabbit.yaml
Review profile: CHILL

.github/workflows/build-binaries.yaml (2)

25-49: Enhance input descriptions for better clarity.

The workflow_dispatch inputs could be more descriptive:

1. For binary input, include brief descriptions of what each binary does (hoprd/hopli)
2. For target input, consider grouping options by platform (Linux/Darwin) for better organization

       binary:
         required: true
-        description: 'Binary to build'
+        description: 'Binary to build (hoprd: HOPR node daemon, hopli: HOPR CLI tool)'
         type: choice
         options:
           - hoprd
           - hopli
       target:
         type: choice
         options:
+          # Linux targets
           - x86_64-linux
           - aarch64-linux
           - armv7l-linux
+          # Darwin targets
           - x86_64-darwin
           - aarch64-darwin
         required: true
-        description: 'Architecture to build for'
+        description: 'Target architecture and platform to build for (Linux/Darwin)'

---

123-124: Add error handling for build step.

The build step should include error handling to ensure failures are properly caught and reported.

       - name: Build ${{ steps.vars.outputs.binary }} binaries
-        run: nix build .#${{ steps.vars.outputs.binary }}${{ steps.vars.outputs.package_suffix }} -L
+        run: |
+          set -eo pipefail
+          if ! nix build .#${{ steps.vars.outputs.binary }}${{ steps.vars.outputs.package_suffix }} -L; then
+            echo "::error::Failed to build ${{ steps.vars.outputs.binary }} for ${{ steps.vars.outputs.target }}"
+            exit 1
+          fi

Configuration used: .coderabbit.yaml
Review profile: CHILL

.github/workflows/build-binaries.yaml (1)

123-124: Add error handling for the build step.

The build step should handle potential failures gracefully and provide clear error messages.

      - name: Build ${{ steps.vars.outputs.binary }} binaries
        run: |
+         set -eo pipefail
+         echo "::group::Building ${{ steps.vars.outputs.binary }}"
          nix build .#${{ steps.vars.outputs.binary }}${{ steps.vars.outputs.package_suffix }} -L
+         if [ ! -d "result/bin" ]; then
+           echo "::error::Build failed: Binary not found in result/bin"
+           exit 1
+         fi
+         echo "::endgroup::"

Configuration used: .coderabbit.yaml
Review profile: CHILL

-    if: contains(github.event.pull_request.labels.*.name, format('binary:{0}', inputs.target)) || github.event.inputs.binary
-    runs-on: ${{ inputs.runner || github.event.inputs.runner }}
+    if: github.event_name == 'workflow_dispatch' || (github.event_name == 'workflow_call' && contains(github.event.pull_request.labels.*.name, format('binary:{0}', inputs.target)))
+    runs-on: ${{ github.event.inputs.runner || inputs.runner }}

.github/workflows/build-binaries.yaml (2)

25-49: Enhance input descriptions for better clarity.

Consider adding more detailed descriptions:

1. For the binary input, describe what each option represents
2. For the runner input, make the architecture mapping more explicit

       binary:
         required: true
-        description: 'Binary to build'
+        description: 'Binary to build: hoprd (node daemon) or hopli (command-line interface)'
         type: choice
         options:
           - hoprd
           - hopli
       runner:
         type: choice
         options:
           - self-hosted-hoprnet-bigger
           - macos-13
           - macos-14
         required: true
-        description: 'GH Runner to use: macos-13=x86_64-darwin and macos-14=aarch64-darwin'
+        description: 'Runner to use: self-hosted-hoprnet-bigger (Linux), macos-13 (x86_64-darwin), macos-14 (aarch64-darwin)'

---

102-117: Enhance build steps with timeouts and error handling.

Consider adding:

1. Timeout for Nix installation
2. Error handling for the build step
3. Build status verification

       - name: Install Nix
         if: steps.vars.outputs.runner_needs_nix_setup == 'true'
         uses: cachix/install-nix-action@v29
+        timeout-minutes: 5
         with:
           github_access_token: ${{ secrets.GITHUB_TOKEN }}
           nix_path: nixpkgs=channel:nixos-24.05

       - uses: cachix/cachix-action@v15
         if: steps.vars.outputs.runner_needs_nix_setup == 'true'
+        timeout-minutes: 5
         with:
           name: hoprnet
           authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
         env:
           USER: runner

       - name: Build ${{ steps.vars.outputs.binary }} binaries
-        run: nix build .#${{ steps.vars.outputs.binary }}${{ steps.vars.outputs.package_suffix }} -L
+        run: |
+          set -eo pipefail
+          nix build .#${{ steps.vars.outputs.binary }}${{ steps.vars.outputs.package_suffix }} -L
+          if [ ! -f "result/bin/${{ steps.vars.outputs.binary }}" ]; then
+            echo "::error::Build failed: Binary not found at expected location"
+            exit 1
+          fi

Configuration used: .coderabbit.yaml
Review profile: CHILL

.github/workflows/build-binaries.yaml (1)

105-109: Consider making Nix path configurable.

The Nix path is hardcoded to nixos-24.05. Consider making it configurable through workflow inputs or repository variables for better maintainability.

       - name: Install Nix
         if: steps.vars.outputs.runner_needs_nix_setup == 'true'
         uses: cachix/install-nix-action@v29
         with:
           github_access_token: ${{ secrets.GITHUB_TOKEN }}
-          nix_path: nixpkgs=channel:nixos-24.05
+          nix_path: nixpkgs=channel:${{ vars.NIX_CHANNEL || 'nixos-24.05' }}

Configuration used: .coderabbit.yaml
Review profile: CHILL

-    if: contains(github.event.pull_request.labels.*.name, format('binary:{0}', inputs.target)) || github.event.inputs.binary
-    runs-on: ${{ inputs.runner || github.event.inputs.runner }}
+    if: >-
+      (github.event_name == 'workflow_dispatch' && github.event.inputs.binary != '') ||
+      (github.event_name == 'workflow_call' && inputs.target != '' && contains(github.event.pull_request.labels.*.name, format('binary:{0}', inputs.target)))
+    runs-on: ${{ github.event.inputs.runner || inputs.runner }}

Configuration used: .coderabbit.yaml
Review profile: CHILL