Add GitHub + IDA HCLI setup by Jinmo · Pull Request #37 · Jinmo/ifred

Jinmo · 2025-12-26T03:14:31Z

No description provided.

Copilot

Pull request overview

This PR migrates the CI/CD pipeline from Azure Pipelines to GitHub Actions, introducing automated builds using the IDA HCLI (Hex-Rays Command Line Interface) tool to download IDA SDK and binaries directly from Hex-Rays.

Key changes:

Replaces Azure Pipelines with GitHub Actions workflow for building IDA plugins
Introduces HCLI-based dependency management for IDA SDK and IDA Free downloads
Builds Qt6 from source with IDA-compatible namespace configuration across all platforms

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 11 comments.

File	Description
`.github/workflows/build.yml`	New GitHub Actions workflow defining Linux, Windows, and macOS build jobs with HCLI integration
`README.md`	Updates CI badge from Azure Pipelines to GitHub Actions
`azure-pipelines.yml`	Removes legacy Azure Pipelines configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-26T03:17:36Z

.github/workflows/build.yml

+
+on:
+  push:
+    branches: [master, github-ci]


The workflow is configured to trigger on pushes to the 'github-ci' branch, which appears to be a temporary development/testing branch. If this PR is being merged to master, consider removing 'github-ci' from the trigger branches to avoid unintended workflow executions on what might be a feature branch.

Suggested change

branches: [master, github-ci]

branches: [master]

Copilot · 2025-12-26T03:17:37Z

.github/workflows/build.yml

+            -DCMAKE_OSX_ARCHITECTURES="arm64" \
+            -DPYTHON_SUPPORT=OFF \
+            -DIDA_SDK=${{ github.workspace }}/ida-sdk \
+            -DIDA_INSTALL_DIR="${{ github.workspace }}/ida-install/IDA Free 9.2.app/Contents/MacOS" \


The DIDA_INSTALL_DIR path contains a hardcoded version-specific directory name "IDA Free 9.2.app". This creates a maintenance burden as the path will need to be updated whenever IDA version changes. Consider using a variable or dynamically finding the IDA installation path to make the workflow more maintainable.

Copilot · 2025-12-26T03:17:37Z

.github/workflows/build.yml

+          # Find where IDA was installed
+          echo "=== Installed files ==="
+          find ${{ github.workspace }}/ida-install -name "*.app" -o -name "libida*" -o -name "ida" 2>/dev/null | head -20
+          ls -la ${{ github.workspace }}/ida-install/


The debug output commands (echo and find) appear to be leftover debugging code from development. These lines don't serve a functional purpose in the build process and add noise to the CI logs. Consider removing them unless they're intentionally kept for troubleshooting purposes.

Suggested change

# Find where IDA was installed

echo "=== Installed files ==="

find ${{ github.workspace }}/ida-install -name "*.app" -o -name "libida*" -o -name "ida" 2>/dev/null | head -20

ls -la ${{ github.workspace }}/ida-install/

Copilot · 2025-12-26T03:17:37Z

.github/workflows/build.yml

+    env:
+      HCLI_API_KEY: ${{ secrets.HCLI_API_KEY }}


The HCLI_API_KEY secret is exposed to the entire job environment, which could potentially leak through log outputs or error messages. Consider using the secret only in the specific steps that require it by setting it as an environment variable at the step level rather than the job level, limiting the exposure surface.

Copilot · 2025-12-26T03:17:37Z

.github/workflows/build.yml

+    env:
+      HCLI_API_KEY: ${{ secrets.HCLI_API_KEY }}


The HCLI_API_KEY secret is exposed to the entire job environment, which could potentially leak through log outputs or error messages. Consider using the secret only in the specific steps that require it by setting it as an environment variable at the step level rather than the job level, limiting the exposure surface.

Copilot · 2025-12-26T03:17:38Z

.github/workflows/build.yml

+      - name: Install HCLI
+        run: pip install ida-hcli


The pip install command does not pin the version of ida-hcli, which could lead to inconsistent builds if the package is updated. Consider pinning to a specific version (e.g., 'pip install ida-hcli==X.Y.Z') to ensure reproducible builds across all platforms.

Copilot · 2025-12-26T03:17:38Z

.github/workflows/build.yml

+          hcli --disable-updates download release/9.2/sdk-and-utilities/idasdk92.zip
+          unzip -q idasdk92.zip -d ./ida-temp
+          mv ./ida-temp/src ./ida-sdk
+
+      - name: Download and Install IDA Free
+        run: |
+          hcli --disable-updates download release/9.2/ida-free/ida-free-pc_92_x64linux.run
+          chmod +x ida-free-pc_92_x64linux.run
+          ./ida-free-pc_92_x64linux.run --mode unattended --prefix ${{ github.workspace }}/ida
+


The hcli download commands and subsequent operations lack explicit error handling. If the download fails or the file is corrupted, the unzip/mv commands will fail with unclear error messages. Consider adding error checking after each critical step or using 'set -e' at the beginning of the script block to ensure the job fails immediately on any error.

Suggested change

hcli --disable-updates download release/9.2/sdk-and-utilities/idasdk92.zip

unzip -q idasdk92.zip -d ./ida-temp

mv ./ida-temp/src ./ida-sdk

- name: Download and Install IDA Free

run: |

hcli --disable-updates download release/9.2/ida-free/ida-free-pc_92_x64linux.run

chmod +x ida-free-pc_92_x64linux.run

./ida-free-pc_92_x64linux.run --mode unattended --prefix ${{ github.workspace }}/ida

set -euo pipefail

hcli --disable-updates download release/9.2/sdk-and-utilities/idasdk92.zip || { echo "ERROR: Failed to download IDA SDK (idasdk92.zip) with hcli."; exit 1; }

if [ ! -f idasdk92.zip ]; then

echo "ERROR: Expected IDA SDK archive 'idasdk92.zip' not found after download."

exit 1

fi

unzip -q idasdk92.zip -d ./ida-temp || { echo "ERROR: Failed to unzip IDA SDK archive 'idasdk92.zip'."; exit 1; }

if [ ! -d ./ida-temp/src ]; then

echo "ERROR: Expected IDA SDK directory './ida-temp/src' not found after unzip."

exit 1

fi

mv ./ida-temp/src ./ida-sdk || { echo "ERROR: Failed to move IDA SDK directory from './ida-temp/src' to './ida-sdk'."; exit 1; }

- name: Download and Install IDA Free

run: |

set -euo pipefail

hcli --disable-updates download release/9.2/ida-free/ida-free-pc_92_x64linux.run || { echo "ERROR: Failed to download IDA Free installer with hcli."; exit 1; }

if [ ! -f ida-free-pc_92_x64linux.run ]; then

echo "ERROR: Expected IDA Free installer 'ida-free-pc_92_x64linux.run' not found after download."

exit 1

fi

chmod +x ida-free-pc_92_x64linux.run || { echo "ERROR: Failed to make IDA Free installer executable."; exit 1; }

./ida-free-pc_92_x64linux.run --mode unattended --prefix ${{ github.workspace }}/ida || { echo "ERROR: IDA Free installer failed."; exit 1; }

Copilot · 2025-12-26T03:17:38Z

.github/workflows/build.yml

+      - name: Configure CMake
+        shell: bash
+        run: |
+          cmake -B build -G Ninja \
+            -DCMAKE_PREFIX_PATH="${{ github.workspace }}/qt-install" \
+            -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+            -DPYTHON_SUPPORT=OFF \
+            -DIDA_SDK="${{ github.workspace }}/ida-sdk" \
+            -DIDA_BINARY_64=ON \
+            -DIDA_EA_64=ON


The Windows build job is missing the IDA installation step that is present in both the Linux (line 41-45) and macOS (line 218-223) jobs. Without IDA installed, the DIDA_INSTALL_DIR CMake variable is not set, which may cause the build to fail if the CMake configuration requires it. Consider adding a step to download and install IDA Free for Windows similar to the other platforms.

Copilot · 2025-12-26T03:17:39Z

.github/workflows/build.yml

+    env:
+      HCLI_API_KEY: ${{ secrets.HCLI_API_KEY }}


The HCLI_API_KEY secret is exposed to the entire job environment, which could potentially leak through log outputs or error messages. Consider using the secret only in the specific steps that require it by setting it as an environment variable at the step level rather than the job level, limiting the exposure surface.

Copilot · 2025-12-26T03:17:39Z

.github/workflows/build.yml

+        run: brew install cmake ninja
+
+      - name: Install HCLI
+        run: pip3 install ida-hcli --break-system-packages


The pip install command does not pin the version of ida-hcli, which could lead to inconsistent builds if the package is updated. Consider pinning to a specific version (e.g., 'pip3 install ida-hcli==X.Y.Z --break-system-packages') to ensure reproducible builds across all platforms.

Suggested change

run: pip3 install ida-hcli --break-system-packages

run: pip3 install ida-hcli==1.5.0 --break-system-packages

Jinmo · 2025-12-26T04:35:20Z

ok let's try

Jinmo requested a review from Copilot December 26, 2025 03:14

Copilot started reviewing on behalf of Jinmo December 26, 2025 03:14 View session

Copilot AI reviewed Dec 26, 2025

View reviewed changes

Jinmo force-pushed the github-ci branch from a39e329 to 5a654f6 Compare December 26, 2025 03:59

Add GitHub + IDA HCLI setup

05ec71c

Jinmo force-pushed the github-ci branch from 5a654f6 to 05ec71c Compare December 26, 2025 04:00

Jinmo merged commit 0cbead1 into master Dec 26, 2025
4 checks passed

Jinmo deleted the github-ci branch December 26, 2025 04:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GitHub + IDA HCLI setup#37

Add GitHub + IDA HCLI setup#37
Jinmo merged 1 commit intomasterfrom
github-ci

Jinmo commented Dec 26, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Copilot AI Dec 26, 2025

Uh oh!

Jinmo commented Dec 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-          hcli --disable-updates download release/9.2/sdk-and-utilities/idasdk92.zip
-          unzip -q idasdk92.zip -d ./ida-temp
-          mv ./ida-temp/src ./ida-sdk
-      - name: Download and Install IDA Free
-        run: |
-          hcli --disable-updates download release/9.2/ida-free/ida-free-pc_92_x64linux.run
-          chmod +x ida-free-pc_92_x64linux.run
-          ./ida-free-pc_92_x64linux.run --mode unattended --prefix ${{ github.workspace }}/ida
+          set -euo pipefail
+          hcli --disable-updates download release/9.2/sdk-and-utilities/idasdk92.zip || { echo "ERROR: Failed to download IDA SDK (idasdk92.zip) with hcli."; exit 1; }
+          if [ ! -f idasdk92.zip ]; then
+            echo "ERROR: Expected IDA SDK archive 'idasdk92.zip' not found after download."
+            exit 1
+          fi
+          unzip -q idasdk92.zip -d ./ida-temp || { echo "ERROR: Failed to unzip IDA SDK archive 'idasdk92.zip'."; exit 1; }
+          if [ ! -d ./ida-temp/src ]; then
+            echo "ERROR: Expected IDA SDK directory './ida-temp/src' not found after unzip."
+            exit 1
+          fi
+          mv ./ida-temp/src ./ida-sdk || { echo "ERROR: Failed to move IDA SDK directory from './ida-temp/src' to './ida-sdk'."; exit 1; }
+      - name: Download and Install IDA Free
+        run: |
+          set -euo pipefail
+          hcli --disable-updates download release/9.2/ida-free/ida-free-pc_92_x64linux.run || { echo "ERROR: Failed to download IDA Free installer with hcli."; exit 1; }
+          if [ ! -f ida-free-pc_92_x64linux.run ]; then
+            echo "ERROR: Expected IDA Free installer 'ida-free-pc_92_x64linux.run' not found after download."
+            exit 1
+          fi
+          chmod +x ida-free-pc_92_x64linux.run || { echo "ERROR: Failed to make IDA Free installer executable."; exit 1; }
+          ./ida-free-pc_92_x64linux.run --mode unattended --prefix ${{ github.workspace }}/ida || { echo "ERROR: IDA Free installer failed."; exit 1; }

	run: pip3 install ida-hcli --break-system-packages
	run: pip3 install ida-hcli==1.5.0 --break-system-packages

Conversation

Jinmo commented Dec 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Jinmo commented Dec 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants