Plan with -detailed-exitcode option returns error

[aminzar-access]

Hi,
Running plan with -detailed-exitcode reports error. Thanks.

      - name: Terraform Plan
        id: plan
        run: terraform -chdir=${{ env.working_directory}} plan -refresh=${{ github.event_name != 'pull_request' }} -out ${{ env.tf_plan_file }} -detailed-exitcode -no-color
        continue-on-error: true

[Michaelvsk]

That's not related to setup-terraform action. Github Actions handle all nonzero exit codes as errors and therefore let the script end immediately and prints an error.

If you do not need to process the detailed exit code, then just omit the parameter. If you want to do different things based on the exit code, then you are in the same situation as I am currently. So far I haven't found a workaround to retrieve the detailed exit code but do not let the script stop immedialty.

[Michaelvsk]

I were wrong. It is in indeed related as it seems that Error: Terraform exited with code 2. is printed when using the option terraform-wrapper: true.
My script is

- run: |
  terraform plan -out ${{ inputs.terraform-plan-artifact-name }} -detailed-exitcode || true

so bash counts it as exit code 0 and the step is also finishing successfully. It still prints the error to log and build summary page

[culpinnis]

Hi together,
We used a snippet like this before to determine if the plan contained any changes.

          set +e
          terraform plan ${{ inputs.TF_VARS }} -detailed-exitcode -out=deploy_${{ github.run_number }}.tfplan ${{ steps.SetTerraformDestroyFlag.outputs.destroyFlag }}
          exitcode=$?
          if [[ $exitcode -eq 2 ]]; then
            echo '::set-output name=planHasChanges::true'
            exit 0
          else
            exit $exitcode
          fi

This works fine when using an ubuntu runner without the TF setup action.
When using the provided Hashicorp action with the following code, I get the same issue.

      - uses: hashicorp/setup-terraform@v1
        name: Setup Terraform on private runner

Of course, I can use || true, but then I do not know if the plan has any changes (the error is reported to the log, but the exit code is 0 instead of 2).
Any ideas on how to deal with that? Is this a general GitHub action issue or related to this specific action?

[aereal]

This is an issue that comes from @actions/core function.

hashicorp/setup-terraform provides the terraform(1) wrapper and it uses @actions/core.setFailed function.
refs.

setup-terraform/index.js

Line 9 in 8b4c280

core.setFailed(error.message);

@actions/core.setFailed always sets exit code as 1 and discards terraform plan's exit code such as 2.
refs. https://github.com/actions/toolkit/blob/main/packages/core/src/core.ts#L213-L217

We can obtain correct exit code from terraform(1) to specify terraform_wrapper: false and use bare terraform CLI.

[aminzar-access]

This is an issue that comes from @actions/core function.

hashicorp/setup-terraform provides the terraform(1) wrapper and it uses @actions/core.setFailed function. refs.

setup-terraform/index.js

Line 9 in 8b4c280

core.setFailed(error.message);

@actions/core.setFailed always sets exit code as 1 and discards terraform plan's exit code such as 2. refs. https://github.com/actions/toolkit/blob/main/packages/core/src/core.ts#L213-L217

We can obtain correct exit code from terraform(1) to specify terraform_wrapper: false and use bare terraform CLI.

Hi @aereal, how do we get stdout, stderr and the exitcode with terraform_wrapper: false? I can't find any samples. Thanks

[aereal]

@aminzar-access

You may be able to set those values using workflow commands.

steps:
  - id: terraform
    run: |
      set +e # allow the workflow to continue following steps even if the `terraform` execution failed
      terraform ... 1>stdout 2>stderr
      tf_exitcode=$?
      echo "::set-output name=exitcode::$tf_exitcode"
      echo "::set-output name=stdout::$(cat ./stdout)"
      echo "::set-output name=stderr::$(cat ./stderr)"

(I'm not sure using set-output with multi-line text works correctly)

[aminzar-access]

Thanks for your help @aereal, really appreciate it.

[aminzar-access]

@aereal unfortunately seems like exitcode is not being set and stdout doesn't have a value when you have multiple terraform commands in workflow.

[jpogran]

We recently merged #125, which handles both 0 and 2 as exitcodes. If you could test by using that git commit I would sincerely appreciate it. An official tag will be created when 2.1.0 is released

[aminzar-access]

@jpogran looks like it has solved the issue, no more errors and I can still get the proper exitcode, thanks.

[ianhundere]

any word as to when 2.1.0 will be released?

[brettcurtis]

Hoping for 2.1.0 soon too, this is really confusing to our users.

[austinvalle]

Closing this issue as it seems the fix was released in v2.0.1 👍🏻

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.