Add linting for protobuf files via Super lint #1211
Workflow file for this run
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
| # Copyright 2023 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| # Adapted from https://github.com/takahirom/roborazzi-compare-on-github-comment-sample/blob/main/.github/workflows/CompareScreenshot.yml | |
| name: CompareScreenshot | |
| on: | |
| pull_request: | |
| jobs: | |
| compare-with-base-branch: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| permissions: | |
| contents: read # for clone | |
| actions: write # for upload-artifact | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1 | |
| with: | |
| egress-policy: audit | |
| - name: Checkout | |
| uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1 | |
| with: | |
| distribution: temurin | |
| java-version: 17 | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2 | |
| - name: Download screenshots from base branch | |
| uses: dawidd6/action-download-artifact@09f2f74827fd3a8607589e5ad7f9398816f540fe # v3.1.4 | |
| continue-on-error: true | |
| with: | |
| name: screenshots | |
| workflow: roborazzi-record-screenshot.yml | |
| branch: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }} | |
| - name: Compare Screenshots | |
| id: compare-screenshot-test | |
| run: | | |
| ./gradlew compareRoborazziDebug --stacktrace | |
| - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
| if: ${{ always() }} | |
| with: | |
| name: diff-vs-base-branch | |
| path: | | |
| **/build/outputs/roborazzi | |
| **/build/reports/roborazzi | |
| retention-days: 30 | |
| - name: Save PR number | |
| if: ${{ github.event_name == 'pull_request' }} | |
| run: | | |
| mkdir -p ./pr | |
| echo ${{ github.event.number }} > ./pr/NR | |
| - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
| with: | |
| name: pr | |
| path: pr/ | |
| Update-Comment: | |
| needs: compare-with-base-branch | |
| timeout-minutes: 2 | |
| permissions: | |
| actions: read # for downloading artifacts | |
| contents: write # for pushing screenshot-diff to companion branch | |
| pull-requests: write # for creating a comment on pull requests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1 | |
| with: | |
| egress-policy: audit | |
| - name: Checkout base | |
| id: checkout-base | |
| uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 | |
| with: | |
| ref: ${{ github.event.pull_request.base.ref }} | |
| - name: Switch to companion branch | |
| id: switch-companion-branch | |
| env: | |
| BRANCH_NAME: roborazzi_companion_${{ github.event.pull_request.head.ref }} | |
| run: | | |
| # orphan means it will create no history branch | |
| git branch -D "$BRANCH_NAME" || true | |
| git checkout --orphan "$BRANCH_NAME" | |
| git rm -rf . | |
| - name: Download diff | |
| uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 | |
| with: | |
| name: diff-vs-base-branch | |
| path: screenshot-diff | |
| - id: check-if-there-are-valid-files | |
| name: Check if there are valid files | |
| shell: bash | |
| run: | | |
| # Find all the files ending with _compare.png | |
| mapfile -t files_to_add < <(find . -type f -name "*_compare.png") | |
| # Check for invalid file names and add only valid ones | |
| exist_valid_files="false" | |
| for file in "${files_to_add[@]}"; do | |
| if [[ $file =~ ^[a-zA-Z0-9_./-]+$ ]]; then | |
| exist_valid_files="true" | |
| break | |
| fi | |
| done | |
| echo "exist_valid_files=$exist_valid_files" >> "$GITHUB_OUTPUT" | |
| - id: push-screenshot-diff | |
| shell: bash | |
| if: steps.check-if-there-are-valid-files.outputs.exist_valid_files == 'true' | |
| env: | |
| BRANCH_NAME: roborazzi_companion_${{ github.event.pull_request.head.ref }} | |
| run: | | |
| # Find all the files ending with _compare.png | |
| files_to_add=$(find . -type f -name "*_compare.png") | |
| # Check for invalid file names and add only valid ones | |
| for file in $files_to_add; do | |
| if [[ "$file" =~ ^[a-zA-Z0-9_./-]+$ ]]; then | |
| git add "$file" | |
| fi | |
| done | |
| git config --global user.name ScreenshotBot | |
| git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| git commit -m "Add screenshot diff" | |
| git push origin HEAD:"$BRANCH_NAME" -f | |
| - id: generate-diff-reports | |
| name: Generate diff reports | |
| env: | |
| BRANCH_NAME: roborazzi_companion_${{ github.event.pull_request.head.ref }} | |
| shell: bash | |
| run: | | |
| delimiter="$(openssl rand -hex 8)" | |
| { | |
| echo "reports<<${delimiter}" | |
| # Create markdown table header | |
| echo "Snapshot diff report vs base branch: ${{ github.event.pull_request.base.ref }}" | |
| echo "Last updated: $(TZ='America/Los_Angeles' date), Sha: ${{ github.event.pull_request.head.sha }}" | |
| } >> "$GITHUB_OUTPUT" | |
| if [[ ${{ steps.check-if-there-are-valid-files.outputs.exist_valid_files }} == 'true' ]]; then | |
| # Find all the files ending with _compare.png in roborazzi folder | |
| files=$(find . -type f -name "*_compare.png" | grep "roborazzi/" | grep -E "^[a-zA-Z0-9_./-]+$") | |
| { | |
| echo "| File name | Image |" | |
| echo "|-------|-------|" | |
| } >> "$GITHUB_OUTPUT" | |
| # Iterate over the files and create table rows | |
| for file in $files; do | |
| # Get the file name and insert newlines every 20 characters | |
| fileName=$(basename "$file" | sed -r 's/(.{20})/\1<br>/g') | |
| echo "| [$fileName](https://github.com/${{ github.repository }}/blob/$BRANCH_NAME/$file) |  |" >> "$GITHUB_OUTPUT" | |
| done | |
| ### Else there were no differences | |
| else | |
| { | |
| echo "No differences detected" | |
| } >> "$GITHUB_OUTPUT" | |
| fi | |
| echo "${delimiter}" >> "$GITHUB_OUTPUT" | |
| - name: Find Comment | |
| uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0 | |
| id: fc | |
| if: steps.generate-diff-reports.outputs.reports != '' | |
| with: | |
| issue-number: ${{ github.event.number }} | |
| comment-author: 'github-actions[bot]' | |
| body-includes: Snapshot diff report | |
| - name: Add or update comment on PR | |
| uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0 | |
| if: steps.generate-diff-reports.outputs.reports != '' | |
| with: | |
| comment-id: ${{ steps.fc.outputs.comment-id }} | |
| issue-number: ${{ github.event.number }} | |
| body: ${{ steps.generate-diff-reports.outputs.reports }} | |
| edit-mode: replace | |
| - name: Cleanup outdated companion branches | |
| run: | | |
| # Find outdated companion branches with last commit date | |
| git branch -r --format="%(refname:lstrip=3)" | grep roborazzi_companion_ | while read -r branch; do | |
| last_commit_date_timestamp=$(git log -1 --format=%ct "origin/$branch") | |
| now_timestamp=$(date +%s) | |
| # Delete branch if it's older than 1 month | |
| if [ $((now_timestamp - last_commit_date_timestamp)) -gt 2592000 ]; then | |
| echo "Deleting $branch" | |
| git push origin --delete "$branch" | |
| fi | |
| done |