Refactor Github Action per b/485167538

Author: benknutson-google

.github/workflows/android.yml

@@ -79,8 +79,11 @@ jobs:
       - name: Set env variables for subsequent steps (all)
         shell: bash
         run: |
-          echo "MATRIX_UNIQUE_NAME=${{ matrix.os }}-${{ matrix.architecture }}" >> $GITHUB_ENV
+          echo "MATRIX_UNIQUE_NAME=${MATRIX_OS}-${MATRIX_ARCHITECTURE}" >> $GITHUB_ENV
           echo "GHA_INSTALL_CCACHE=1" >> $GITHUB_ENV
+        env:
+          MATRIX_OS: ${{ matrix.os }}
+          MATRIX_ARCHITECTURE: ${{ matrix.architecture }}
 
       - name: Setup python
         uses: actions/setup-python@v4

.github/workflows/checks.yml

@@ -117,13 +117,18 @@ jobs:
           README_FILE=release_build_files/readme.md
           # Determine the github merge base - same logic as integration_tests.yml
           # "git merge-base main branch_name" will give the common ancestor of both branches.
-          MERGE_BASE=$(git merge-base origin/${{github.event.pull_request.head.ref}} origin/${{github.event.pull_request.base.ref}} || true)
+          MERGE_BASE=$(git merge-base origin/${GITHUB_EVENT_PULL_REQUEST_HEAD_REF} origin/${GITHUB_EVENT_PULL_REQUEST_BASE_REF} || true)
           # If MERGE_BASE can't be determined, ignore this check, something odd is going on.
           if [[ -n "${MERGE_BASE}" ]]; then
-            DIFF_RESULT=$(git diff --name-only "origin/${{github.event.pull_request.head.ref}}..${MERGE_BASE}" -- "${README_FILE}")
+            DIFF_RESULT=$(git diff --name-only "origin/${GITHUB_EVENT_PULL_REQUEST_HEAD_REF}..${MERGE_BASE}" -- "${README_FILE}")
             if [[ "${DIFF_RESULT}" != "${README_FILE}" ]]; then
               echo "::error ::Please update release notes (${README_FILE}) or add '${{env.skipReleaseNotesLabel}}' label."
               exit 1
             fi
           fi
+
+        env:
+          GITHUB_EVENT_PULL_REQUEST_HEAD_REF: ${{github.event.pull_request.head.ref}}
+
+          GITHUB_EVENT_PULL_REQUEST_BASE_REF: ${{github.event.pull_request.base.ref}}
 

.github/workflows/cpp-packaging.yml

@@ -46,11 +46,14 @@ jobs:
     steps:
       - name: log run inputs
         run: |
-          if [[ -n "${{ github.event.inputs.downloadPublicVersion }}" ]]; then
-            echo "::warning ::Downloading public SDK package from https://dl.google.com/firebase/sdk/cpp/firebase_cpp_sdk_${{ github.event.inputs.downloadPublicVersion }}.zip"
-          elif [[ -n "${{ github.event.inputs.downloadPreviousRun }}" ]]; then
-            echo "::warning ::Downloading SDK package from previous run at https://github.com/firebase/firebase-cpp-sdk/actions/runs/${{ github.event.inputs.downloadPreviousRun }}"
+          if [[ -n "${GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION}" ]]; then
+            echo "::warning ::Downloading public SDK package from https://dl.google.com/firebase/sdk/cpp/firebase_cpp_sdk_${GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION}.zip"
+          elif [[ -n "${GITHUB_EVENT_INPUTS_DOWNLOADPREVIOUSRUN}" ]]; then
+            echo "::warning ::Downloading SDK package from previous run at https://github.com/firebase/firebase-cpp-sdk/actions/runs/${GITHUB_EVENT_INPUTS_DOWNLOADPREVIOUSRUN}"
           fi
+        env:
+          GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION: ${{ github.event.inputs.downloadPublicVersion }}
+          GITHUB_EVENT_INPUTS_DOWNLOADPREVIOUSRUN: ${{ github.event.inputs.downloadPreviousRun }}
 
       - name: log if skipping integration tests
         if: |
@@ -413,10 +416,12 @@ jobs:
         shell: bash
         run: |
           verbose_flag=
-          if [[ -n "${{ github.event.inputs.verboseBuild }}" && "${{ github.event.inputs.verboseBuild }}" -ne 0 ]]; then
+          if [[ -n "${GITHUB_EVENT_INPUTS_VERBOSEBUILD}" && "${GITHUB_EVENT_INPUTS_VERBOSEBUILD}" -ne 0 ]]; then
             verbose_flag=--verbose
           fi
           echo "VERBOSE_FLAG=${verbose_flag}" >> $GITHUB_ENV
+        env:
+          GITHUB_EVENT_INPUTS_VERBOSEBUILD: ${{ github.event.inputs.verboseBuild }}
 
       # Run the build in the host OS default shell since Windows can't handle long path names in bash.
       - name: Build desktop SDK
@@ -430,7 +435,7 @@ jobs:
           find .. -type f -print > src_file_list.txt
           # Remove intermediate build files (.o and .obj) files to save space.
           find . -type f -name '*.o' -or -name '*.obj' -print0 | xargs -0 rm -f --
-          tar -czhf ../firebase-cpp-sdk-${{ env.SDK_NAME }}-build.tgz .
+          tar -czhf ../firebase-cpp-sdk-${SDK_NAME}-build.tgz .
 
       - name: Print built libraries
         shell: bash
@@ -664,19 +669,21 @@ jobs:
       - name: fetch public SDK package from web
         if: ${{ github.event.inputs.downloadPublicVersion != '' && github.event.inputs.downloadPreviousRun == '' }}
         run: |
-          if [[ ! "${{ github.event.inputs.downloadPublicVersion }}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-            echo Invalid version number: "${{ github.event.inputs.downloadPublicVersion }}"
+          if [[ ! "${GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo Invalid version number: "${GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION}"
             exit 1
           fi
           set +e
           # Retry up to 10 times because Curl has a tendency to timeout on
           # Github runners.
           for retry in {1..10} error; do
           if [[ $retry == "error" ]]; then exit 5; fi
-            curl -L https://dl.google.com/firebase/sdk/cpp/firebase_cpp_sdk_${{ github.event.inputs.downloadPublicVersion }}.zip --output firebase_cpp_sdk.zip && break
+            curl -L https://dl.google.com/firebase/sdk/cpp/firebase_cpp_sdk_${GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION}.zip --output firebase_cpp_sdk.zip && break
             sleep 300
           done
           set -e
+        env:
+          GITHUB_EVENT_INPUTS_DOWNLOADPUBLICVERSION: ${{ github.event.inputs.downloadPublicVersion }}
 
       - name: compute SDK hash
         shell: bash
@@ -817,21 +824,21 @@ jobs:
           USE_EXPANDED_MATRIX=0
         fi
         verbose_flag=
-        if [[ -n "${{ github.event.inputs.verboseBuild }}" && "${{ github.event.inputs.verboseBuild }}" -ne 0 ]]; then
+        if [[ -n "${GITHUB_EVENT_INPUTS_VERBOSEBUILD}" && "${GITHUB_EVENT_INPUTS_VERBOSEBUILD}" -ne 0 ]]; then
           verbose_flag=-v
         fi
         set -e
         if [[ "${{ github.event_name }}" == "schedule" ]]; then
           # trigger integration tests and generate two reports for nightly workflow run: one for firestore, one for the rest.
-          python scripts/gha/trigger_workflow.py -t ${{ steps.generate-token.outputs.token }} \
+          python scripts/gha/trigger_workflow.py -t ${STEPS_GENERATE_TOKEN_OUTPUTS_TOKEN} \
             -w integration_tests.yml \
             -p test_packaged_sdk ${{ github.run_id }} \
             -p use_expanded_matrix ${USE_EXPANDED_MATRIX} \
             -p apis "admob,analytics,auth,database,dynamic_links,functions,installations,messaging,remote_config,storage" \
             -p test_pull_request nightly-packaging \
             -s 10 \
             -A ${verbose_flag}
-          python scripts/gha/trigger_workflow.py -t ${{ steps.generate-token.outputs.token }} \
+          python scripts/gha/trigger_workflow.py -t ${STEPS_GENERATE_TOKEN_OUTPUTS_TOKEN} \
             -w integration_tests.yml \
             -p test_packaged_sdk ${{ github.run_id }} \
             -p use_expanded_matrix ${USE_EXPANDED_MATRIX} \
@@ -841,10 +848,13 @@ jobs:
             -A ${verbose_flag}
         else
           # trigger integration tests
-          python scripts/gha/trigger_workflow.py -t ${{ steps.generate-token.outputs.token }} \
+          python scripts/gha/trigger_workflow.py -t ${STEPS_GENERATE_TOKEN_OUTPUTS_TOKEN} \
             -w integration_tests.yml \
             -p test_packaged_sdk ${{ github.run_id }} \
             -p use_expanded_matrix ${USE_EXPANDED_MATRIX} \
             -s 10 \
             -A ${verbose_flag}
         fi
+      env:
+        GITHUB_EVENT_INPUTS_VERBOSEBUILD: ${{ github.event.inputs.verboseBuild }}
+        STEPS_GENERATE_TOKEN_OUTPUTS_TOKEN: ${{ steps.generate-token.outputs.token }}

.github/workflows/desktop.yml

@@ -128,25 +128,33 @@ jobs:
         if: startsWith(matrix.os, 'windows')
         shell: bash
         run: |
-          if [[ ${{matrix.msvc_runtime}}  == "static" ]];
+          if [[ ${MATRIX_MSVC_RUNTIME}  == "static" ]];
             then echo "VCPKG_SUFFIX=windows-static" >> $GITHUB_ENV;
-          elif [[ ${{matrix.msvc_runtime}} == "dynamic" ]];
+          elif [[ ${MATRIX_MSVC_RUNTIME} == "dynamic" ]];
             then echo "VCPKG_SUFFIX=windows-static-md" >> $GITHUB_ENV;
           else
             echo "Warning, could not resolve vcpkg suffix.";
           fi
+        env:
+          MATRIX_MSVC_RUNTIME: ${{matrix.msvc_runtime}}
 
       - name: Set env variables for subsequent steps (all)
         shell: bash
         run: |
-          echo "BUILD_TYPE: ${{ matrix.build_type }}"
-          echo "VCPKG_SUFFIX: ${{env.VCPKG_SUFFIX}}"
-          echo "VCPKG_RESPONSE_FILE=external/vcpkg_custom_data/response_files/${{ matrix.architecture }}-${{ env.VCPKG_SUFFIX }}.txt" >> $GITHUB_ENV
-          echo "MATRIX_UNIQUE_NAME=${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.msvc_runtime }}" >> $GITHUB_ENV
+          echo "BUILD_TYPE: ${MATRIX_BUILD_TYPE}"
+          echo "VCPKG_SUFFIX: ${VCPKG_SUFFIX}"
+          echo "VCPKG_RESPONSE_FILE=external/vcpkg_custom_data/response_files/${MATRIX_ARCHITECTURE}-${VCPKG_SUFFIX}.txt" >> $GITHUB_ENV
+          echo "MATRIX_UNIQUE_NAME=${MATRIX_OS}-${MATRIX_BUILD_TYPE}-${MATRIX_ARCHITECTURE}-${MATRIX_MSVC_RUNTIME}" >> $GITHUB_ENV
           if [[ '${{ matrix.sdk_platform }}' == 'darwin' ]]; then
             # If Mac, also hash vcpkg cache on Xcode version.
-            echo "VCPKG_EXTRA_HASH=-xcode${{matrix.xcode_version}}" >> $GITHUB_ENV
+            echo "VCPKG_EXTRA_HASH=-xcode${MATRIX_XCODE_VERSION}" >> $GITHUB_ENV
           fi
+        env:
+          MATRIX_BUILD_TYPE: ${{ matrix.build_type }}
+          MATRIX_ARCHITECTURE: ${{ matrix.architecture }}
+          MATRIX_OS: ${{ matrix.os }}
+          MATRIX_MSVC_RUNTIME: ${{ matrix.msvc_runtime }}
+          MATRIX_XCODE_VERSION: ${{matrix.xcode_version}}
 
       - name: Cache vcpkg C++ dependencies
         id: cache_vcpkg
@@ -180,7 +188,11 @@ jobs:
       - name: Build SDK
         shell: bash
         run: |
-          python scripts/gha/build_desktop.py --build_tests --arch "${{ matrix.architecture }}" --config "${{ matrix.build_type }}" --msvc_runtime_library "${{ matrix.msvc_runtime }}" --gha_build
+          python scripts/gha/build_desktop.py --build_tests --arch "${MATRIX_ARCHITECTURE}" --config "${MATRIX_BUILD_TYPE}" --msvc_runtime_library "${MATRIX_MSVC_RUNTIME}" --gha_build
+        env:
+          MATRIX_ARCHITECTURE: ${{ matrix.architecture }}
+          MATRIX_BUILD_TYPE: ${{ matrix.build_type }}
+          MATRIX_MSVC_RUNTIME: ${{ matrix.msvc_runtime }}
 
       - name: Stats for ccache (mac and linux)
         if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macos')
@@ -340,9 +352,11 @@ jobs:
         shell: bash
         run: |
           cat build-results-desktop-ubuntu-20.04-openssl.log
-          if [[ "${{ job.status }}" != "success" ]]; then
+          if [[ "${JOB_STATUS}" != "success" ]]; then
             exit 1
           fi
+        env:
+          JOB_STATUS: ${{ job.status }}
       - name: Set up Node (16)
         uses: actions/setup-node@v3
         with:
@@ -370,6 +384,8 @@ jobs:
         shell: bash
         run: |
           cat testapps-desktop-ubuntu-20.04-openssl/test-results-desktop-ubuntu-20.04-openssl.log
-          if [[ "${{ job.status }}" != "success" ]]; then
+          if [[ "${JOB_STATUS}" != "success" ]]; then
             exit 1
           fi
+        env:
+          JOB_STATUS: ${{ job.status }}