Skip to content

chore(run-digger-action): separate digger binary setup from execution #2287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from
Draft

chore(run-digger-action): separate digger binary setup from execution #2287

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a2ca94
separate binary config from execution
sidpalas Oct 2, 2025
43f7ef0
Set DEBUG when building from source
sidpalas Oct 2, 2025
484794f
Merge branch 'develop' into sp/split-binary-config-from-execution
sidpalas Oct 7, 2025
656b94f
Merge branch 'develop' into sp/split-binary-config-from-execution
sidpalas Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 35 additions & 96 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ inputs:

outputs:
output:
value: ${{ steps.digger.outputs.output }}
value: ${{ steps.run-digger.outputs.output }}
description: The terraform output

runs:
Expand Down Expand Up @@ -461,42 +461,10 @@ runs:
mkdir -p $GITHUB_WORKSPACE/cache
shell: bash

- name: build and run digger
- name: build digger from source
if: ${{ steps.determine-binary-mode.outputs.binary-mode == 'build' }}
shell: bash
env:
PLAN_UPLOAD_DESTINATION: ${{ inputs.upload-plan-destination }}
PLAN_UPLOAD_S3_ENCRYPTION_ENABLED: ${{ inputs.upload-plan-destination-s3-encryption-enabled }}
PLAN_UPLOAD_S3_ENCRYPTION_TYPE: ${{ inputs.upload-plan-destination-s3-encryption-type }}
PLAN_UPLOAD_S3_ENCRYPTION_KMS_ID: ${{ inputs.upload-plan-destination-s3-encryption-kms-key-id }}
PLAN_UPLOAD_AZURE_STORAGE_CONTAINER_NAME: ${{ inputs.upload-plan-destination-azure-container }}
PLAN_UPLOAD_AZURE_STORAGE_ACCOUNT_NAME: ${{ inputs.upload-plan-destination-azure-storage-account }}
GOOGLE_STORAGE_LOCK_BUCKET: ${{ inputs.google-lock-bucket }}
GOOGLE_STORAGE_PLAN_ARTEFACT_BUCKET: ${{ inputs.upload-plan-destination-gcp-bucket }}
AWS_S3_BUCKET: ${{ inputs.upload-plan-destination-s3-bucket }}
ACTIVATE_VENV: ${{ inputs.setup-checkov == 'true' }}
DISABLE_LOCKING: ${{ inputs.disable-locking == 'true' }}
DIGGER_PRIVATE_KEY: ${{ inputs.digger-private-key }}
DIGGER_TOKEN: ${{ inputs.digger-token }}
DIGGER_ORGANISATION: ${{ inputs.digger-organisation }}
DIGGER_HOSTNAME: ${{ inputs.digger-hostname }}
DIGGER_FILENAME: ${{ inputs.digger-filename }}
ACCUMULATE_PLANS: ${{ inputs.post-plans-as-one-comment == 'true' }}
REPORTING_STRATEGY: ${{ inputs.reporting-strategy }}
INPUT_DIGGER_PROJECT: ${{ inputs.project }}
INPUT_DIGGER_MODE: ${{ inputs.mode }}
INPUT_DIGGER_COMMAND: ${{ inputs.command }}
INPUT_DRIFT_DETECTION_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-slack-notification-url }}
INPUT_DRIFT_DETECTION_ADVANCED_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-advanced-slack-notification-url }}

NO_BACKEND: ${{ inputs.no-backend }}
DEBUG: "true"
TG_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TERRAGRUNT_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TF_PLUGIN_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TG_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TERRAGRUNT_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
DIGGER_RUN_SPEC: ${{inputs.digger-spec}}
run: |
if [[ ${{ inputs.ee }} == "true" ]]; then
cd $GITHUB_ACTION_PATH/ee/cli
Expand All @@ -511,43 +479,11 @@ runs:
chmod +x digger
PATH=$PATH:$(pwd)
cd $GITHUB_WORKSPACE
digger

- name: download, install, and run digger
- name: download and install prebuilt digger
if: ${{ steps.determine-binary-mode.outputs.binary-mode == 'prebuilt' }}
env:
DIGGER_VERSION: ${{ inputs.digger-version || github.action_ref }}
PLAN_UPLOAD_DESTINATION: ${{ inputs.upload-plan-destination }}
PLAN_UPLOAD_S3_ENCRYPTION_ENABLED: ${{ inputs.upload-plan-destination-s3-encryption-enabled }}
PLAN_UPLOAD_S3_ENCRYPTION_TYPE: ${{ inputs.upload-plan-destination-s3-encryption-type }}
PLAN_UPLOAD_S3_ENCRYPTION_KMS_ID: ${{ inputs.upload-plan-destination-s3-encryption-kms-key-id }}
PLAN_UPLOAD_AZURE_STORAGE_CONTAINER_NAME: ${{ inputs.upload-plan-destination-azure-container }}
PLAN_UPLOAD_AZURE_STORAGE_ACCOUNT_NAME: ${{ inputs.upload-plan-destination-azure-storage-account }}
GOOGLE_STORAGE_LOCK_BUCKET: ${{ inputs.google-lock-bucket }}
GOOGLE_STORAGE_PLAN_ARTEFACT_BUCKET: ${{ inputs.upload-plan-destination-gcp-bucket }}
AWS_S3_BUCKET: ${{ inputs.upload-plan-destination-s3-bucket }}
ACTIVATE_VENV: ${{ inputs.setup-checkov == 'true' }}
DISABLE_LOCKING: ${{ inputs.disable-locking == 'true' }}
DIGGER_PRIVATE_KEY: ${{ inputs.digger-private-key }}
DIGGER_TOKEN: ${{ inputs.digger-token }}
DIGGER_ORGANISATION: ${{ inputs.digger-organisation }}
DIGGER_HOSTNAME: ${{ inputs.digger-hostname }}
DIGGER_FILENAME: ${{ inputs.digger-filename }}
ACCUMULATE_PLANS: ${{ inputs.post-plans-as-one-comment == 'true' }}
REPORTING_STRATEGY: ${{ inputs.reporting-strategy }}
INPUT_DIGGER_PROJECT: ${{ inputs.project }}
INPUT_DIGGER_MODE: ${{ inputs.mode }}
INPUT_DIGGER_COMMAND: ${{ inputs.command }}
INPUT_DRIFT_DETECTION_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-slack-notification-url }}
INPUT_DRIFT_DETECTION_ADVANCED_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-advanced-slack-notification-url }}
NO_BACKEND: ${{ inputs.no-backend }}
TG_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TERRAGRUNT_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TF_PLUGIN_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TG_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TERRAGRUNT_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
DIGGER_RUN_SPEC: ${{inputs.digger-spec}}
id: digger
shell: bash
run: |
set -euo pipefail
Expand Down Expand Up @@ -597,12 +533,38 @@ runs:
echo "Successfully downloaded and prepared Digger CLI"
PATH=$PATH:$(pwd)
cd $GITHUB_WORKSPACE
digger

- name: run digger in local dev mode
- name: Validate local digger binary config
if: ${{ steps.determine-binary-mode.outputs.binary-mode == 'local' }}
shell: bash
run: |
set -euo pipefail

cd $GITHUB_WORKSPACE

echo "🚀 Running digger..."
RAW="${{ inputs.local-dev-cli-path }}"

# Validate path to prevent command injection
if [[ "$RAW" =~ [^a-zA-Z0-9_./-] ]]; then
echo "❌ Invalid characters in local-dev-cli-path"
exit 1
fi

if [[ "$RAW" =~ \.\. || "$RAW" == : || "$RAW" != /* ]]; then
echo "❌ traversal/colon/relative not allowed"; exit 1
fi

DIR=$(realpath -- "$RAW") || { echo "❌ not found"; exit 1; }
[[ -d "$DIR" ]] || { echo "❌ not a dir"; exit 1; }

BIN="$DIR/digger"
[[ -x "$BIN" ]] || { echo "❌ digger not executable at $BIN"; exit 1; }
PATH=$PATH:$(DIR)
cd $DIR

- name: Run Digger
env:
DIGGER_VERSION: ${{ github.action_ref }}
PLAN_UPLOAD_DESTINATION: ${{ inputs.upload-plan-destination }}
PLAN_UPLOAD_S3_ENCRYPTION_ENABLED: ${{ inputs.upload-plan-destination-s3-encryption-enabled }}
PLAN_UPLOAD_S3_ENCRYPTION_TYPE: ${{ inputs.upload-plan-destination-s3-encryption-type }}
Expand All @@ -627,40 +589,17 @@ runs:
INPUT_DRIFT_DETECTION_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-slack-notification-url }}
INPUT_DRIFT_DETECTION_ADVANCED_SLACK_NOTIFICATION_URL: ${{ inputs.drift-detection-advanced-slack-notification-url }}
NO_BACKEND: ${{ inputs.no-backend }}
DEBUG: ${{ !startsWith(github.action_ref, 'v') && inputs.local-dev-mode == 'false' }}
TG_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TERRAGRUNT_PROVIDER_CACHE: ${{ (inputs.cache-dependencies == 'true' || inputs.cache-dependencies-s3 == 'true') && 1 || 0 }}
TF_PLUGIN_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TG_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
TERRAGRUNT_PROVIDER_CACHE_DIR: ${{ env.TF_PLUGIN_CACHE_DIR }}
DIGGER_RUN_SPEC: ${{inputs.digger-spec}}
id: digger-local-run
id: run-digger
shell: bash
run: |
set -euo pipefail

cd $GITHUB_WORKSPACE

echo "🚀 Running digger..."
RAW="${{ inputs.local-dev-cli-path }}"

# Validate path to prevent command injection
if [[ "$RAW" =~ [^a-zA-Z0-9_./-] ]]; then
echo "❌ Invalid characters in local-dev-cli-path"
exit 1
fi

if [[ "$RAW" =~ \.\. || "$RAW" == : || "$RAW" != /* ]]; then
echo "❌ traversal/colon/relative not allowed"; exit 1
fi

DIR=$(realpath -- "$RAW") || { echo "❌ not found"; exit 1; }
[[ -d "$DIR" ]] || { echo "❌ not a dir"; exit 1; }

BIN="$DIR/digger"
[[ -x "$BIN" ]] || { echo "❌ digger not executable at $BIN"; exit 1; }

$BIN
echo "✅ digger completed"
digger

- uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
name: cache-save
Expand Down
Loading