141 automate upgrade safety check in ci pipeline

[RonTuretzky]

No description provided.

[Copilot]

Pull Request Overview

This PR automates upgrade safety checks in the CI pipeline by adding validation for smart contract upgrades and tracking flattened contract versions. The purpose is to ensure upgrade compatibility is verified automatically before merging code changes.

• Added automated upgrade safety validation for both YieldDistributor and ButteredBread contracts
• Integrated upgrade checks into the CI workflow that runs on pull requests and pushes
• Added contract flattening and version tracking to maintain upgrade reference points

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
script/upgrades/ValidateUpgrade.s.sol	Updated script to validate upgrades for both YieldDistributor and ButteredBread contracts with proper configuration
.github/workflows/test.yml	Added upgrade safety job and contract flattening workflow with version tracking

[bagelface]

probably better to use stable tagged build https://github.com/foundry-rs/foundry/releases/tag/stable

[RonTuretzky]

b3eac0f

[bagelface]

if we use stable tag we can remove this

[RonTuretzky]

b3eac0f

[bagelface]

Don't love the contract paths being hardcoded since it'll require more maintenance this way (it's actually already out of date because it's missing "VotingMultipliers"). I think it'd be better to dynamically pull the contracts at the top level of /src. For example:

name: test

on:
  workflow_dispatch:
  pull_request:
    branches: [ dev, main ]
  push:
    branches: [ dev, main ]

env:
  FOUNDRY_PROFILE: ci

jobs:
  check:
    strategy:
      fail-fast: true

    name: Foundry project
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: stable

      - name: Run Forge build
        run: |
          forge --version
          forge build --sizes
        id: build

      - name: Run Forge tests
        run: |
          forge test -vvv
        id: test

  upgrade-safety:
    name: Upgrade Safety Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: stable

      - name: Run upgrade safety validation
        run: |
          forge clean && forge build
          
          if [ -d "test/upgrades/previous" ] && ls test/upgrades/previous/*.sol 1> /dev/null 2>&1; then
            echo "Previous contracts found, running upgrade validation..."
            forge script script/upgrades/ValidateUpgrade.s.sol
          else
            echo "No previous contracts found, skipping upgrade validation (initial deployment)"
          fi

  flatten:
    name: Flatten and Track Contracts
    runs-on: ubuntu-latest
    needs: [check, upgrade-safety]
    
    if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
    
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
          fetch-depth: 0

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: stable

      - name: Create flattened contracts directory
        run: mkdir -p test/upgrades/current

      - name: Flatten all top-level contracts
        run: |
          # Find all Solidity files directly under src/, not nested
          for contract in $(find src -maxdepth 1 -type f -name "*.sol"); do
            name=$(basename "$contract")
            forge flatten "$contract" > "test/upgrades/current/$name"
          done
          
          # Backup for future upgrade validations
          rm -rf test/upgrades/previous
          cp -r test/upgrades/current test/upgrades/previous
          
          echo "Flattened contracts saved to test/upgrades/current/"
          echo "Previous version backed up to test/upgrades/previous/"

      - name: Commit flattened contracts
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          file_pattern: test/upgrades/**/*.sol
          commit_message: "chore: auto-flatten contracts after validation passes [skip ci]"
          push_options: '--follow-tags'

[RonTuretzky]

b3eac0f

[bagelface]

Also should include "VotingMultipliers" contract

[bagelface]

lgtm