API Verification #978
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "API Verification" | |
| on: | |
| workflow_run: | |
| workflows: [Ubuntu packaging] | |
| types: | |
| - completed | |
| env: | |
| STATUS_CONTEXT: 'API Verification' | |
| PKG_NAME: 'libkeymancore' | |
| GH_TOKEN: ${{ github.token }} | |
| jobs: | |
| api_verification: | |
| name: Verify API for libkeymancore*.so | |
| runs-on: ubuntu-latest | |
| outputs: | |
| VERSION: ${{ steps.environment_step.outputs.VERSION }} | |
| PRERELEASE_TAG: ${{ steps.environment_step.outputs.PRERELEASE_TAG }} | |
| GIT_SHA: ${{ steps.environment_step.outputs.GIT_SHA }} | |
| GIT_BASE: ${{ steps.environment_step.outputs.GIT_BASE }} | |
| IS_TEST_BUILD: ${{ steps.environment_step.outputs.IS_TEST_BUILD }} | |
| GIT_BRANCH: ${{ steps.environment_step.outputs.GIT_BRANCH }} | |
| GIT_BASE_BRANCH: ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }} | |
| GIT_USER: ${{ steps.environment_step.outputs.GIT_USER }} | |
| steps: | |
| - name: Restore artifacts | |
| uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | |
| with: | |
| path: | | |
| artifacts | |
| key: artifacts-key-${{ github.event.workflow_run.id }} | |
| restore-keys: artifacts-key- | |
| - name: Read environment | |
| id: environment_step | |
| run: | | |
| cat artifacts/env >> $GITHUB_OUTPUT | |
| - name: Set pending status on PR builds | |
| id: set_status | |
| if: steps.environment_step.outputs.IS_TEST_BUILD == 'true' | |
| shell: bash | |
| run: | | |
| gh api \ | |
| --method POST \ | |
| -H "Accept: application/vnd.github+json" \ | |
| /repos/$GITHUB_REPOSITORY/statuses/${{ steps.environment_step.outputs.GIT_SHA }} \ | |
| -f state='pending' \ | |
| -f target_url="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" \ | |
| -f description='API verification started' \ | |
| -f context="$STATUS_CONTEXT" | |
| - name: Checkout | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1 | |
| with: | |
| ref: '${{ steps.environment_step.outputs.GIT_SHA }}' | |
| fetch-depth: 0 | |
| clean: false | |
| path: ${{ github.workspace }}/keyman/ | |
| - name: Install devscripts | |
| uses: ./keyman/.github/actions/apt-install | |
| with: | |
| packages: devscripts equivs | |
| - name: "Verify API for libkeymancore*.so (${{ steps.environment_step.outputs.GIT_BRANCH }}, branch ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }}, by ${{ steps.environment_step.outputs.GIT_USER }})" | |
| run: | | |
| echo "Verify API for libkeymancore*.so (${{ steps.environment_step.outputs.GIT_BRANCH }}, branch ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }}, by ${{ steps.environment_step.outputs.GIT_USER }}):" >> $GITHUB_STEP_SUMMARY | |
| BIN_PACKAGE=$(ls "${GITHUB_WORKSPACE}/artifacts/" | grep "${PKG_NAME}[0-9]*_${{ steps.environment_step.outputs.VERSION }}-1${{ steps.environment_step.outputs.PRERELEASE_TAG }}+$(lsb_release -c -s)1_amd64.deb") | |
| cd ${{ github.workspace }}/keyman/linux | |
| ./scripts/deb-packaging.sh \ | |
| --gha \ | |
| --bin-pkg "${GITHUB_WORKSPACE}/artifacts/${BIN_PACKAGE}" \ | |
| --git-sha "${{ steps.environment_step.outputs.GIT_SHA }}" \ | |
| --git-base "${{ steps.environment_step.outputs.GIT_BASE }}" \ | |
| verify 2>> $GITHUB_STEP_SUMMARY | |
| - name: Archive .symbols file | |
| uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0 | |
| with: | |
| name: libkeymancore.symbols | |
| path: ${{ github.workspace }}/keyman/linux/debian/tmp/DEBIAN/symbols | |
| if: always() | |
| set_status: | |
| name: Set result status on PR builds | |
| needs: [api_verification] | |
| runs-on: ubuntu-latest | |
| if: ${{ always() && needs.api_verification.outputs.IS_TEST_BUILD == 'true' }} | |
| steps: | |
| - name: Set success | |
| if: needs.api_verification.result == 'success' | |
| run: | | |
| echo "RESULT=success" >> $GITHUB_ENV | |
| echo "MSG=API verification succeeded" >> $GITHUB_ENV | |
| - name: Set cancelled | |
| if: needs.api_verification.result == 'cancelled' | |
| run: | | |
| echo "RESULT=error" >> $GITHUB_ENV | |
| echo "MSG=API verification cancelled" >> $GITHUB_ENV | |
| - name: Set failure | |
| if: needs.api_verification.result == 'failure' | |
| run: | | |
| echo "RESULT=failure" >> $GITHUB_ENV | |
| echo "MSG=API verification failed" >> $GITHUB_ENV | |
| - name: Set final status | |
| run: | | |
| gh api \ | |
| --method POST \ | |
| -H "Accept: application/vnd.github+json" \ | |
| /repos/$GITHUB_REPOSITORY/statuses/${{ needs.api_verification.outputs.GIT_SHA }} \ | |
| -f state="$RESULT" \ | |
| -f target_url="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" \ | |
| -f description="$MSG" \ | |
| -f context="$STATUS_CONTEXT" |