ci: add toggles to ui report (#33577) #10
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: "ui preview" | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request_target: | |
| types: [assigned, opened, synchronize, reopened, edited] | |
| branches: | |
| - 'master' | |
| paths: | |
| - 'selfdrive/ui/**' | |
| workflow_dispatch: | |
| env: | |
| UI_JOB_NAME: "Create UI Report" | |
| REPORT_NAME: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && 'master' || github.event.number }} | |
| SHA: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.sha || github.event.pull_request.head.sha }} | |
| BRANCH_NAME: "openpilot/pr-${{ github.event.number }}" | |
| jobs: | |
| preview: | |
| if: github.repository == 'commaai/openpilot' | |
| name: preview | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| actions: read | |
| steps: | |
| - name: Waiting for ui generation to start | |
| run: sleep 30 | |
| - name: Waiting for ui generation to end | |
| uses: lewagon/[email protected] | |
| with: | |
| ref: ${{ env.SHA }} | |
| check-name: ${{ env.UI_JOB_NAME }} | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| allowed-conclusions: success | |
| wait-interval: 20 | |
| - name: Getting workflow run ID | |
| id: get_run_id | |
| run: | | |
| echo "run_id=$(curl https://api.github.com/repos/${{ github.repository }}/commits/${{ env.SHA }}/check-runs | jq -r '.check_runs[] | select(.name == "${{ env.UI_JOB_NAME }}") | .html_url | capture("(?<number>[0-9]+)") | .number')" >> $GITHUB_OUTPUT | |
| - name: Getting proposed ui | |
| id: download-artifact | |
| uses: dawidd6/action-download-artifact@v6 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| run_id: ${{ steps.get_run_id.outputs.run_id }} | |
| search_artifacts: true | |
| name: report-${{ env.REPORT_NAME }} | |
| path: ${{ github.workspace }}/pr_ui | |
| - name: Getting master ui | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: commaai/ci-artifacts | |
| ssh-key: ${{ secrets.CI_ARTIFACTS_DEPLOY_KEY }} | |
| path: ${{ github.workspace }}/master_ui | |
| ref: openpilot_master_ui | |
| - name: Saving new master ui | |
| if: github.ref == 'refs/heads/master' && github.event_name == 'push' | |
| working-directory: ${{ github.workspace }}/master_ui | |
| run: | | |
| git checkout --orphan=new_master_ui | |
| git rm -rf * | |
| git branch -D openpilot_master_ui | |
| git branch -m openpilot_master_ui | |
| git config user.name "GitHub Actions Bot" | |
| git config user.email "<>" | |
| mv ${{ github.workspace }}/pr_ui/*.png . | |
| git add . | |
| git commit -m "screenshots for commit ${{ env.SHA }}" | |
| git push origin openpilot_master_ui --force | |
| - name: Finding diff | |
| if: github.event_name == 'pull_request_target' | |
| id: find_diff | |
| run: >- | |
| sudo apt-get install -y imagemagick | |
| scenes="homescreen settings_device settings_toggles offroad_alert update_available prime onroad onroad_sidebar onroad_wide onroad_wide_sidebar onroad_alert_small onroad_alert_mid onroad_alert_full driver_camera body keyboard" | |
| A=($scenes) | |
| DIFF="" | |
| TABLE="<details>" | |
| TABLE="${TABLE}<summary>All Screenshots</summary>" | |
| TABLE="${TABLE}<table>" | |
| for ((i=0; i<${#A[*]}; i=i+1)); | |
| do | |
| if ! compare -fuzz 2% -highlight-color DeepSkyBlue1 -lowlight-color Black -compose Src ${{ github.workspace }}/master_ui/${A[$i]}.png ${{ github.workspace }}/pr_ui/${A[$i]}.png ${{ github.workspace }}/pr_ui/${A[$i]}_diff.png; then | |
| convert ${{ github.workspace }}/pr_ui/${A[$i]}_diff.png -transparent black mask.png | |
| composite mask.png ${{ github.workspace }}/master_ui/${A[$i]}.png composite_diff.png | |
| convert -delay 20 ${{ github.workspace }}/master_ui/${A[$i]}.png composite_diff.png -loop 0 ${{ github.workspace }}/pr_ui/${A[$i]}_diff.gif | |
| mv ${{ github.workspace }}/master_ui/${A[$i]}.png ${{ github.workspace }}/pr_ui/${A[$i]}_master_ref.png | |
| DIFF="${DIFF}<details>" | |
| DIFF="${DIFF}<summary>${A[$i]} : \$\${\\color{red}\\text{DIFFERENT}}\$\$</summary>" | |
| DIFF="${DIFF}<table>" | |
| DIFF="${DIFF}<tr>" | |
| DIFF="${DIFF} <td> master <img src=\"https://raw.githubusercontent.com/commaai/ci-artifacts/${{ env.BRANCH_NAME }}/${A[$i]}_master_ref.png\"> </td>" | |
| DIFF="${DIFF} <td> proposed <img src=\"https://raw.githubusercontent.com/commaai/ci-artifacts/${{ env.BRANCH_NAME }}/${A[$i]}.png\"> </td>" | |
| DIFF="${DIFF}</tr>" | |
| DIFF="${DIFF}<tr>" | |
| DIFF="${DIFF} <td> diff <img src=\"https://raw.githubusercontent.com/commaai/ci-artifacts/${{ env.BRANCH_NAME }}/${A[$i]}_diff.png\"> </td>" | |
| DIFF="${DIFF} <td> composite diff <img src=\"https://raw.githubusercontent.com/commaai/ci-artifacts/${{ env.BRANCH_NAME }}/${A[$i]}_diff.gif\"> </td>" | |
| DIFF="${DIFF}</tr>" | |
| DIFF="${DIFF}</table>" | |
| DIFF="${DIFF}</details>" | |
| else | |
| rm -f ${{ github.workspace }}/pr_ui/${A[$i]}_diff.png | |
| fi | |
| INDEX=$(($i % 2)) | |
| if [[ $INDEX -eq 0 ]]; then | |
| TABLE="${TABLE}<tr>" | |
| fi | |
| TABLE="${TABLE} <td> <img src=\"https://raw.githubusercontent.com/commaai/ci-artifacts/${{ env.BRANCH_NAME }}/${A[$i]}.png\"> </td>" | |
| if [[ $INDEX -eq 1 || $(($i + 1)) -eq ${#A[*]} ]]; then | |
| TABLE="${TABLE}</tr>" | |
| fi | |
| done | |
| TABLE="${TABLE}</table>" | |
| TABLE="${TABLE}</details>" | |
| echo "DIFF=$DIFF$TABLE" >> "$GITHUB_OUTPUT" | |
| - name: Saving proposed ui | |
| if: github.event_name == 'pull_request_target' | |
| working-directory: ${{ github.workspace }}/master_ui | |
| run: | | |
| git config user.name "GitHub Actions Bot" | |
| git config user.email "<>" | |
| git checkout --orphan=${{ env.BRANCH_NAME }} | |
| git rm -rf * | |
| mv ${{ github.workspace }}/pr_ui/* . | |
| git add . | |
| git commit -m "screenshots for PR #${{ github.event.number }}" | |
| git push origin ${{ env.BRANCH_NAME }} --force | |
| - name: Comment Screenshots on PR | |
| if: github.event_name == 'pull_request_target' | |
| uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| message: | | |
| <!-- _(run_id_screenshots **${{ github.run_id }}**)_ --> | |
| ## UI Preview | |
| ${{ steps.find_diff.outputs.DIFF }} | |
| comment_tag: run_id_screenshots | |
| pr_number: ${{ github.event.number }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |