Adding Terraform Outputs to Github PR

Stephen_Bennett · June 28, 2024, 9:24am

trying to improve on the github action outputs. using the below gets me 90% of the way. i just want to add the outputs of tf to it if possible? The onyl way i see to get those values is via a `qovery lifecycle env list --show-values and id then to drop all the other values or just retain those from service terraform. Is there common way to do that?

      - name: Qovery Terraform Deploy
        if: ${{ inputs.terraform-deployment }}
        id: terraform-deploy
        run: |
          qovery lifecycle deploy \
          --organization "Open Corporates" \
          --project "Open Corporates" \
          --lifecycle "terraform" \
          --environment ${{ steps.extract_branch.outputs.branch }} \
          --commit-id $GITHUB_SHA \
          --watch

          qovery_status_markdown_output=`qovery service list \
          --organization "Open Corporates" \
          --project "Open Corporates" \
          --environment ${{ steps.extract_branch.outputs.branch }} \
          --markdown`

          echo "QOVERY_STATUS_MARKDOWN_OUTPUT<<EOF" >> "$GITHUB_OUTPUT"
          echo "$qovery_status_markdown_output" >> "$GITHUB_OUTPUT"
          echo "EOF" >> "$GITHUB_OUTPUT"

        env:
          QOVERY_CLI_ACCESS_TOKEN: ${{ secrets.qovery-token }}


      - name: PR Comment with URL
        uses: mshick/add-pr-comment@v2
        with:
          message-id: Qovery environment
          message: |
            ## Terraform Deployment:

            ${{ steps.terraform-deploy.outputs.QOVERY_STATUS_MARKDOWN_OUTPUT }}

rophilogene · June 28, 2024, 10:00am

Hi @Stephen_Bennett ,

Correct me if I’m wrong, but what do you want is the Terraform execution output? If yes, you have two possibilities:

Solution 1: Lifecycle Job Output

(This is the recommended way for your use case)

Use the Lifecycle Job output to:

Inject the Terraform output into an environment variable (e.g, TERRAFORM_EXEC_OUTPUT)
Retrieve it from the environment variable (e.g. TERRAFORM_EXEC_OUTPUT) so you can read it and use the content with the CLI command:

qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "your-env" \
| jq -r '.[] | select(.key == "TERRAFORM_EXEC_OUTPUT").interpolated_value

Solution 2: Use Lifecycle Logs

Use the qovery log command

E.g. qovery log --organization "Open Corporates" --project "Open Corporates" --environment "your-env" --lifecycle "terraform"

I didn’t try this command - but if it does not work, I can take a look

I hope it helps

Stephen_Bennett · July 1, 2024, 12:05pm

playing around im still not getting the desired output.

because its creating a alias of the output with the correct name and a link to the value and the entry with the value doesnt a custom value name. ie:

    {
        "alias_parent_key": null,
        "created_at": "2024-07-01T10:44:33.634Z",
        "id": "14a24bea-861c-4e8f-8a49-f6d86271cda7",
        "interpolated_value": "data-quality/bot-data-quality/data-expectation-check-dev-1855/user",
        "key": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_SECRETS_PATH",
        "override_parent_value": null,
        "scope": "BUILT_IN",
        "service_name": "terraform",
        "updated_at": "2024-07-01T10:52:18.046Z",
        "value": "data-quality/bot-data-quality/data-expectation-check-dev-1855/user"
    },
    {
        "alias_parent_key": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_SECRETS_PATH",
        "created_at": "2024-07-01T10:44:33.672Z",
        "id": "69b93e0f-59ce-46be-8ab0-871a91b90787",
        "interpolated_value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_SECRETS_PATH",
        "key": "RAKE_USER_SECRETS_PATH",
        "override_parent_value": null,
        "scope": "ENVIRONMENT",
        "service_name": null,
        "updated_at": "2024-07-01T10:44:33.672Z",
        "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_SECRETS_PATH"
    },

where i would like to get:

{
  "key" : "RAKE_USER_SECRETS_PATH"
  "value: : "data-quality/bot-data-quality/data-expectation-check-dev-1855/user"
}

im using:

jq ‘. | select(.scope == “ENVIRONMENT” and .alias_parent_key != null) | {key: .key, value: .value}’

Pierre_Gerbelot · July 1, 2024, 1:14pm

Hello @Stephen_Bennett
It should have been fixed in the CLI version 0.94.17.
Let me know if it is not the case.

Regards

Stephen_Bennett · July 2, 2024, 10:10am

rophilogene:

qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "your-env" \
| jq -r '.[] | select(.key == "TERRAFORM_EXEC_OUTPUT").interpolated_value

so running the above (adding the closing ’ for the jq pipe i get error

% qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "dev-1855" \
| jq -r '.[]' | select(.key == "TERRAFORM_EXEC_OUTPUT").interpolated_value
zsh: no matches found: select(.key == TERRAFORM_EXEC_OUTPUT).interpolated_value
% 
[1]    done         qovery lifecycle env list --json -n "terraform" --organization  --project    | 
       broken pipe  jq -r '.[]'

and running my query i get :

% qovery lifecycle env list --json -n "terraform" \--organization "Open Corporates" \
--project "Open Corporates" \
--environment "dev-1855" \
| jq '.[] | select(.scope == "ENVIRONMENT" and .alias_parent_key != null) | {key: .key, value: .value}'
{
  "key": "S3_DATA_BUCKET",
  "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_S3_DATA_BUCKET"
}
{
  "key": "BATCH_JOB_DEFINITION",
  "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_BATCH_JOB_DEFINITION"
}
{
  "key": "RAKE_USER_NAME",
  "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_NAME"
}
{
  "key": "TF_VAR_QOVERY_ENVIRONMENT_NAME",
  "value": "QOVERY_ENVIRONMENT_NAME"
}
{
  "key": "RAKE_USER_SECRETS_PATH",
  "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_RAKE_USER_SECRETS_PATH"
}
{
  "key": "S3_REPORTS_BUCKET",
  "value": "QOVERY_OUTPUT_JOB_Z3ED32CDA_S3_REPORTS_BUCKET"
}

im on

% qovery version
Info: 0.94.17

Pierre_Gerbelot · July 2, 2024, 10:24am

I’m not sure it is related but the ’ for closing the jq pipe is not at the correct place. It should be at the end after .interpolated_value

qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "your-env" \
| jq -r '.[] | select(.key == "TERRAFORM_EXEC_OUTPUT").interpolated_value '

Stephen_Bennett · July 2, 2024, 1:34pm

interesting… i now get no output from running:

% qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "dev-1855" \
| jq -r '.[] | select(.key == "TERRAFORM_EXEC_OUTPUT").interpolated_value' 
%

Stephen_Bennett · July 2, 2024, 1:40pm

to confirm just running the command to get the json output. there is no key: terraform_exec_output in any of the json.

i do a decent output from :

% qovery lifecycle env list --json -n "terraform" \
--organization "Open Corporates" \
--project "Open Corporates" \
--environment "dev-1855" \
| jq '.[] | select(.scope == "ENVIRONMENT" and .alias_parent_key != null) | {key: .key, value: .interpolated_value}' 
{
  "key": "S3_DATA_BUCKET",
  "value": "oc-idp-data-expectation-check-dev-1855-data"
}
{
  "key": "BATCH_JOB_DEFINITION",
  "value": "oc-idp-data-expectation-check-dev-1855-job"
}
{
  "key": "RAKE_USER_NAME",
  "value": "data-expectation-check-dev-1855-user"
}
{
  "key": "TF_VAR_QOVERY_ENVIRONMENT_NAME",
  "value": "dev-1855"
}
{
  "key": "RAKE_USER_SECRETS_PATH",
  "value": "data-quality/bot-data-quality/data-expectation-check-dev-1855/user"
}
{
  "key": "S3_REPORTS_BUCKET",
  "value": "oc-idp-data-expectation-check-dev-1855-reports"
}

Stephen_Bennett · July 2, 2024, 2:59pm

current working version

      - name: Qovery Terraform Deploy
        if: ${{ inputs.terraform-deployment }}
        id: terraform-deploy
        run: |
          qovery lifecycle deploy \
          --organization "Open Corporates" \
          --project "Open Corporates" \
          --lifecycle "terraform" \
          --environment ${{ steps.extract_branch.outputs.branch }} \
          --commit-id $GITHUB_SHA \
          --watch

          qovery_status_markdown_output=`qovery service list \
          --organization "Open Corporates" \
          --project "Open Corporates" \
          --environment ${{ steps.extract_branch.outputs.branch }} \
          --markdown`

          echo "QOVERY_STATUS_MARKDOWN_OUTPUT<<EOF" >> "$GITHUB_OUTPUT"
          echo "$qovery_status_markdown_output" >> "$GITHUB_OUTPUT"
          echo "EOF" >> "$GITHUB_OUTPUT"

        env:
          QOVERY_CLI_ACCESS_TOKEN: ${{ secrets.qovery-token }}

      - name: Qovery Terraform outputs
        if: ${{ inputs.terraform-deployment }}
        id: terraform-outputs
        run: |
          qovery_terraform_output=`qovery lifecycle env list --json -n "terraform" \
          --organization "Open Corporates" \
          --project "Open Corporates" \
          --environment ${{ steps.extract_branch.outputs.branch }} \
          | jq -r '.[] | select(.scope == "ENVIRONMENT" and .alias_parent_key != null) | [.key, .interpolated_value] | @tsv' \
          | awk -v OFS=" | " 'BEGIN{print "| Key | Value |\n| --- | ----- |"} {print "| "$1, $2" |"}'`

          echo "QOVERY_STATUS_MARKDOWN_OUTPUT<<EOF" >> "$GITHUB_OUTPUT"
          echo "$qovery_terraform_output" >> "$GITHUB_OUTPUT"
          echo "EOF" >> "$GITHUB_OUTPUT"
        env:
          QOVERY_CLI_ACCESS_TOKEN: ${{ secrets.qovery-token }}

      - name: PR Comment with URL
        uses: mshick/add-pr-comment@v2
        with:
          message-id: Qovery environment
          message: |
            ## Terraform Deployment:

            ${{ steps.terraform-deploy.outputs.QOVERY_STATUS_MARKDOWN_OUTPUT }}

            ## Terraform Outputs:

            ${{ steps.terraform-outputs.outputs.QOVERY_STATUS_MARKDOWN_OUTPUT }}

system · July 22, 2024, 1:01pm

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Github action output of qovery variables change? [Read Only] Questions and Answers	10	31	October 9, 2024
Terraform Questions about project environment variables, qovery_git_token [Read Only] Questions and Answers terraform	9	200	April 5, 2024
Deployment doesnt use the latest commit [Read Only] Questions and Answers	5	92	June 24, 2024
How can I get Terraform output values [Read Only] Questions and Answers terraform	3	238	February 28, 2024
How can I pass the PR_ID to a lifecycle job? Deployment preview-environment	11	306	March 14, 2024

Adding Terraform Outputs to Github PR

Solution 1: Lifecycle Job Output

Solution 2: Use Lifecycle Logs

Related topics