|
| 1 | +# Workflow to verify versioning compatibility between base branch and patch versions |
| 2 | +name: Verify Versioning Compatibility |
| 3 | + |
| 4 | +on: |
| 5 | + workflow_dispatch: |
| 6 | + inputs: |
| 7 | + version: |
| 8 | + description: "Version tag to compare (e.g., v1.2.0)" |
| 9 | + required: true |
| 10 | + default: "v1.2.0" |
| 11 | + type: string |
| 12 | + |
| 13 | +jobs: |
| 14 | + verify-versioning: |
| 15 | + runs-on: |
| 16 | + - runs-on=${{ github.run_id }} |
| 17 | + - runner=64cpu-linux-arm64 |
| 18 | + - extras=s3-cache |
| 19 | + - disk=large |
| 20 | + steps: |
| 21 | + - name: Checkout base branch |
| 22 | + uses: actions/checkout@v4 |
| 23 | + |
| 24 | + - name: Set version fallback |
| 25 | + run: echo "version=${{ github.event.inputs.version || 'v1.2.0' }}" >> $GITHUB_ENV |
| 26 | + |
| 27 | + - name: Install solc # svm should support arm64 linux |
| 28 | + run: (hash svm 2>/dev/null || cargo install --version 0.2.23 svm-rs) && svm install 0.8.19 && solc --version |
| 29 | + |
| 30 | + - name: Install Rust |
| 31 | + uses: dtolnay/rust-toolchain@stable |
| 32 | + with: |
| 33 | + toolchain: stable |
| 34 | + |
| 35 | + - name: Cache Cargo dependencies |
| 36 | + uses: Swatinem/rust-cache@v2 |
| 37 | + |
| 38 | + # Build and test from base branch |
| 39 | + - name: Build base branch CLI |
| 40 | + run: cargo install --force --path crates/cli |
| 41 | + |
| 42 | + - name: Run setup from base branch and snapshot ~/.openvm |
| 43 | + run: | |
| 44 | + cargo openvm setup --evm |
| 45 | + rm -rf ~/.openvm-base |
| 46 | + mv ~/.openvm ~/.openvm-base |
| 47 | +
|
| 48 | + # - name: Build and keygen examples from base branch |
| 49 | + # run: | |
| 50 | + # mkdir -p ./base-outputs/examples |
| 51 | + # for example in examples/*/; do |
| 52 | + # if [ -f "$example/Cargo.toml" ]; then |
| 53 | + # example_name=$(basename "$example") |
| 54 | + # echo "Building and generating keys for example: $example_name" |
| 55 | + # cd "$example" |
| 56 | + # cargo openvm build --no-transpile |
| 57 | + # cargo openvm keygen --output-dir "../../base-outputs/examples/$example_name" |
| 58 | + # cd ../.. |
| 59 | + # fi |
| 60 | + # done |
| 61 | + |
| 62 | + - name: Build and keygen benchmarks from base branch |
| 63 | + run: | |
| 64 | + mkdir -p ./base-outputs/benchmarks |
| 65 | + for benchmark in benchmarks/guest/*/; do |
| 66 | + if [ -f "$benchmark/Cargo.toml" ]; then |
| 67 | + benchmark_name=$(basename "$benchmark") |
| 68 | + echo "Building and generating keys for benchmark: $benchmark_name" |
| 69 | + cd "$benchmark" |
| 70 | + cargo openvm build --no-transpile |
| 71 | + cargo openvm keygen --output-dir "../../../base-outputs/benchmarks/$benchmark_name" |
| 72 | + cd ../../.. |
| 73 | + fi |
| 74 | + done |
| 75 | +
|
| 76 | + # Checkout and test tagged version |
| 77 | + - name: Checkout tagged version |
| 78 | + uses: actions/checkout@v4 |
| 79 | + with: |
| 80 | + ref: ${{ env.version }} |
| 81 | + clean: false |
| 82 | + |
| 83 | + - name: Build tagged CLI |
| 84 | + run: cargo install --force --path crates/cli |
| 85 | + |
| 86 | + - name: Run setup from tagged version |
| 87 | + run: | |
| 88 | + # TODO: Add --evm after v1.3.0 release |
| 89 | + cargo openvm setup |
| 90 | +
|
| 91 | + # - name: Build and keygen examples from tagged version |
| 92 | + # run: | |
| 93 | + # mkdir -p ./tagged-outputs/examples |
| 94 | + # for example in examples/*/; do |
| 95 | + # if [ -f "$example/Cargo.toml" ]; then |
| 96 | + # example_name=$(basename "$example") |
| 97 | + # echo "Building and generating keys for example: $example_name" |
| 98 | + # cd "$example" |
| 99 | + # cargo openvm build --no-transpile |
| 100 | + # # TODO(yi): Change --vk-output to --output-dir after v1.3.0 release |
| 101 | + # mkdir -p "../../tagged-outputs/examples/$example_name" |
| 102 | + # cargo openvm keygen --vk-output "../../tagged-outputs/examples/$example_name/app.vk" |
| 103 | + # cd ../.. |
| 104 | + # fi |
| 105 | + # done |
| 106 | + |
| 107 | + - name: Build and keygen benchmarks from tagged version |
| 108 | + run: | |
| 109 | + mkdir -p ./tagged-outputs/benchmarks |
| 110 | + for benchmark in benchmarks/guest/*/; do |
| 111 | + if [ -f "$benchmark/Cargo.toml" ]; then |
| 112 | + benchmark_name=$(basename "$benchmark") |
| 113 | + echo "Building and generating keys for benchmark: $benchmark_name" |
| 114 | + cd "$benchmark" |
| 115 | + cargo openvm build --no-transpile |
| 116 | + # TODO(yi): Change --vk-output to --output-dir after v1.3.0 release |
| 117 | + mkdir -p "../../../tagged-outputs/benchmarks/$benchmark_name" |
| 118 | + cargo openvm keygen --vk-output "../../../tagged-outputs/benchmarks/$benchmark_name/app.vk" |
| 119 | + cd ../../.. |
| 120 | + fi |
| 121 | + done |
| 122 | +
|
| 123 | + # - name: Compare example verification keys |
| 124 | + # run: | |
| 125 | + # echo "Comparing example verification keys between base branch and ${{ env.version }}..." |
| 126 | + # failed=0 |
| 127 | + # for example in examples/*/; do |
| 128 | + # if [ -f "$example/Cargo.toml" ]; then |
| 129 | + # example_name=$(basename "$example") |
| 130 | + # echo "Checking example: $example_name" |
| 131 | + # if cmp "./base-outputs/examples/$example_name/app.vk" "./tagged-outputs/examples/$example_name/app.vk"; then |
| 132 | + # echo "✅ $example_name verification keys are identical" |
| 133 | + # else |
| 134 | + # echo "❌ $example_name verification keys differ" |
| 135 | + # failed=1 |
| 136 | + # fi |
| 137 | + # fi |
| 138 | + # done |
| 139 | + # if [ $failed -eq 1 ]; then |
| 140 | + # echo "❌ Some example verification keys differ - versioning policy violated" |
| 141 | + # exit 1 |
| 142 | + # else |
| 143 | + # echo "✅ All example verification keys are identical" |
| 144 | + # fi |
| 145 | + |
| 146 | + - name: Compare benchmark verification keys |
| 147 | + run: | |
| 148 | + echo "Comparing benchmark verification keys between base branch and ${{ env.version }}..." |
| 149 | + failed=0 |
| 150 | + for benchmark in benchmarks/guest/*/; do |
| 151 | + if [ -f "$benchmark/Cargo.toml" ]; then |
| 152 | + benchmark_name=$(basename "$benchmark") |
| 153 | + echo "Checking benchmark: $benchmark_name" |
| 154 | + if cmp "./base-outputs/benchmarks/$benchmark_name/app.vk" "./tagged-outputs/benchmarks/$benchmark_name/app.vk"; then |
| 155 | + echo "✅ $benchmark_name verification keys are identical" |
| 156 | + else |
| 157 | + echo "❌ $benchmark_name verification keys differ" |
| 158 | + failed=1 |
| 159 | + fi |
| 160 | + fi |
| 161 | + done |
| 162 | + if [ $failed -eq 1 ]; then |
| 163 | + echo "❌ Some benchmark verification keys differ - versioning policy violated" |
| 164 | + exit 1 |
| 165 | + else |
| 166 | + echo "✅ All benchmark verification keys are identical" |
| 167 | + fi |
| 168 | +
|
| 169 | + # Compare all outputs |
| 170 | + # TODO: After v1.3.0 release, just compare the contents of ~/.openvm-base |
| 171 | + # and ~/.openvm |
| 172 | + - name: Compare ~/.openvm contents |
| 173 | + run: | |
| 174 | + echo "🔍 Comparing ~/.openvm agg and halo2 outputs between base branch and ${{ env.version }}..." |
| 175 | +
|
| 176 | + failed=0 |
| 177 | +
|
| 178 | + # Compare agg.pk with agg_halo2.pk |
| 179 | + if cmp ~/.openvm-base/agg.pk ~/.openvm/agg_halo2.pk; then |
| 180 | + echo "✅ agg.pk and agg_halo2.pk are identical" |
| 181 | + else |
| 182 | + echo "❌ agg.pk and agg_halo2.pk differ" |
| 183 | + failed=1 |
| 184 | + fi |
| 185 | +
|
| 186 | + # Compare halo2 directories recursively |
| 187 | + if diff -r ~/.openvm-base/halo2 ~/.openvm/halo2; then |
| 188 | + echo "✅ halo2 directories are identical" |
| 189 | + else |
| 190 | + echo "❌ halo2 directories differ" |
| 191 | + failed=1 |
| 192 | + fi |
| 193 | +
|
| 194 | + if [ $failed -eq 1 ]; then |
| 195 | + echo "❌ ~/.openvm outputs differ" |
| 196 | + exit 1 |
| 197 | + else |
| 198 | + echo "✅ All checked ~/.openvm outputs are identical" |
| 199 | + fi |
| 200 | +
|
| 201 | + - name: Final summary |
| 202 | + run: | |
| 203 | + echo "🎉 Versioning compatibility verification completed successfully!" |
| 204 | + echo "✅ Setup outputs are identical between base branch and ${{ env.version }}" |
| 205 | + echo "✅ All example verification keys are identical" |
| 206 | + echo "✅ All benchmark verification keys are identical" |
| 207 | + echo "✅ Versioning policy maintained - patch upgrade is backward compatible" |
0 commit comments