Add diff against dev branch to help with PR reviews #440
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
| name: CI | |
| on: | |
| workflow_dispatch: | |
| push: | |
| # Only run when there are changes under relevant dirs | |
| paths: | |
| - "proto/**" | |
| - ".github/workflows/**" | |
| - "scripts/**" | |
| branches: | |
| - c4t | |
| - dev | |
| pull_request: | |
| # Only run when there are changes under relevant dirs | |
| paths: | |
| - "proto/**" | |
| - ".github/workflows/**" | |
| - "scripts/**" | |
| jobs: | |
| # Run buf's lint to check for errros | |
| buf-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Install buf | |
| run: | | |
| # Installing buf | |
| if [ "${{ env.buf_version }}" == "" ]; then | |
| # Install latest version | |
| sudo ./scripts/buf-installer.sh | |
| else | |
| # Install the defined version | |
| sudo ./scripts/buf-installer.sh --version=${{ env.buf_version}} | |
| fi | |
| - name: Buf lint | |
| uses: bufbuild/buf-lint-action@v1 | |
| with: | |
| input: "proto" | |
| buf-format: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Install buf | |
| run: | | |
| # Installing buf | |
| if [ "${{ env.buf_version }}" == "" ]; then | |
| # Install latest version | |
| sudo ./scripts/buf-installer.sh | |
| else | |
| # Install the defined version | |
| sudo ./scripts/buf-installer.sh --version=${{ env.buf_version}} | |
| fi | |
| - name: Buf format | |
| run: | | |
| # Run buf format | |
| buf format proto --diff --exit-code | |
| buf-breaking: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Install buf | |
| run: | | |
| # Installing buf | |
| if [ "${{ env.buf_version }}" == "" ]; then | |
| # Install latest version | |
| sudo ./scripts/buf-installer.sh | |
| else | |
| # Install the defined version | |
| sudo ./scripts/buf-installer.sh --version=${{ env.buf_version }} | |
| fi | |
| - name: Buf Breaking Check | |
| run: | | |
| # Run buf breaking against main label on buf.build | |
| buf breaking --against buf.build/chain4travel/camino-messenger-protocol | |
| # diff check against c4t branch to catch breaking changes | |
| diff-c4t: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Run diff against branch | |
| run: scripts/diff_against_branch.sh | |
| # diff check against dev branch to help with the PR reviews | |
| diff-dev: | |
| name: Diff against dev to help with the PR reviews | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Run diff against branch | |
| run: | | |
| scripts/diff_against_branch.sh dev || true | |
| echo -e "\n🛟 Note: This diff check against dev branch is for PR review purposes only." | |
| echo -e "🛟 Any reported differences are informational and not considered errors.\n" | |
| # dependency check to catch if proto files were not updated correctly | |
| dependency-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Run proto dependency check | |
| run: scripts/dependency_checker.py --print-graph | |
| # dependency check to catch if proto files were not updated correctly | |
| analyze-service-tags: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Run service tag analysis | |
| run: scripts/analyze-service-tags.sh proto | |
| # Check if we use FQPN (fully qualified package names) everywhere | |
| fqpn-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Run proto FQPN check | |
| run: scripts/fqpn_check.sh | |
| # Push the draft branch to buf.build | |
| bsr-push-draft: | |
| runs-on: ubuntu-latest | |
| needs: [buf-lint, buf-breaking] | |
| if: ${{ (github.ref == 'refs/heads/draft') || (github.ref == 'refs/heads/dev') }} | |
| environment: draft | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Install Buf | |
| run: | | |
| # Install Buf | |
| if [ "${{ env.buf_version }}" == "" ]; then | |
| # Install latest version | |
| sudo ./scripts/buf-installer.sh | |
| else | |
| # Install the defined version | |
| sudo ./scripts/buf-installer.sh --version=${{ env.buf_version}} | |
| fi | |
| - name: Update URLs with branch name | |
| run: | | |
| # Add branch name to URLs | |
| find proto -type f -name '*.proto' -print0 | xargs -0 -I {} ./scripts/replace_url.sh {} ${{ github.ref_name }} | |
| - name: Push to buf.build | |
| uses: bufbuild/buf-push-action@v1 | |
| with: | |
| input: "proto" | |
| draft: true | |
| buf_token: ${{ secrets.BUF_BSR_TOKEN }} | |
| # Generate and upload protodot diagrams | |
| diagrams: | |
| runs-on: ubuntu-latest | |
| needs: [buf-lint, buf-breaking] | |
| if: ${{ (github.ref == 'refs/heads/draft') || (github.ref == 'refs/heads/dev') || (github.ref == 'refs/heads/c4t') }} | |
| steps: | |
| # Setup environment | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Setup Graphviz | |
| uses: ts-graphviz/setup-graphviz@v1 | |
| - name: Install librsvg2-bin | |
| run: sudo apt-get install -y librsvg2-bin | |
| # Generate diagrams | |
| - name: Generate Diagrams | |
| run: | | |
| # Install protodot | |
| wget https://github.com/seamia/protodot/raw/master/binaries/protodot-linux-amd64 | |
| chmod +x protodot-linux-amd64 | |
| mkdir -v -p gen/bin | |
| mv protodot-linux-amd64 gen/bin/protodot | |
| export PATH=${PWD}/gen/bin:${PATH} | |
| # Run generator script | |
| bash scripts/generate_protodot.sh | |
| # Remove .dot files, we do not need them. | |
| find gen/diagrams -type f -name "*.dot" -exec rm -f {} + | |
| # Show generated files | |
| tree gen/diagrams | |
| # Upload diagrams | |
| - name: Cloud Authentication | |
| id: auth | |
| uses: "google-github-actions/auth@v1" | |
| with: | |
| credentials_json: "${{ secrets.GOOGLE_CREDENTIALS }}" | |
| - name: Setup Cloud SDK | |
| uses: google-github-actions/setup-gcloud@v1 | |
| - name: Upload Diagrams | |
| run: | | |
| # '-J' options is to set Content-Encoding to gzip | |
| gsutil -m rsync -J -R -d gen/diagrams gs://docs-cmp-files/diagrams/${{ github.ref_name }} | |
| - name: Upload Assets | |
| run: | | |
| # '-J' options is to set Content-Encoding to gzip | |
| gsutil -m rsync -J -R -d assets gs://docs-cmp-files/assets/${{ github.ref_name }} |