Merge pull request #728 from rust-embedded/improve-regress

improve regress

.cargo/config.toml

@@ -1,2 +1,5 @@
 [target.aarch64-unknown-linux-gnu]
 linker = "aarch64-linux-gnu-gcc"
+
+[alias]
+regress = "run -p svd2rust-regress --"

.github/workflows/ci.yml

@@ -21,7 +21,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        TARGET: [x86_64-unknown-linux-gnu, x86_64-apple-darwin, x86_64-pc-windows-msvc]
+        TARGET:
+          [
+            x86_64-unknown-linux-gnu,
+            x86_64-apple-darwin,
+            x86_64-pc-windows-msvc,
+          ]
 
     steps:
       - uses: actions/checkout@v4
@@ -171,3 +176,40 @@ jobs:
         uses: Swatinem/rust-cache@v2
 
       - run: cargo fmt --all -- --check
+
+  artifact:
+    name: Build svd2rust artifact
+    if: github.event_name == 'pull_request'
+    needs: [check]
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      matrix:
+        include:
+          - target: x86_64-unknown-linux-gnu
+            runs-on: ubuntu-latest
+          - target: aarch64-apple-darwin
+            runs-on: macos-latest
+          - target: x86_64-pc-windows-msvc
+            runs-on: windows-latest
+            suffix: .exe
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          targets: ${{ matrix.target }}
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v2
+
+      - name: Build svd2rust artifact
+        run: cargo build --release --target ${{ matrix.target }}
+
+      - run: mv target/${{ matrix.target }}/release/svd2rust${{ matrix.suffix || '' }} svd2rust-${{ matrix.target }}-$(git rev-parse --short HEAD)${{ matrix.suffix || '' }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: artifact-svd2rust-${{ matrix.target }}
+          path: svd2rust-${{ matrix.target }}*

.github/workflows/diff.yml

@@ -0,0 +1,76 @@
+name: Diff
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    outputs:
+      diffs: ${{ steps.regress-ci.outputs.diffs }}
+    if: ${{ github.event.issue.pull_request }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "diff"
+
+      - run: cargo regress ci
+        id: regress-ci
+        env:
+          GITHUB_COMMENT: ${{ github.event.comment.body }}
+          GITHUB_COMMENT_PR: ${{ github.event.comment.issue_url }}
+  diff:
+    runs-on: ubuntu-latest
+    needs: [generate]
+    if: needs.generate.outputs.diffs != '{}' && needs.generate.outputs.diffs != '[]' && needs.generate.outputs.diffs != ''
+    strategy:
+      matrix:
+        include: ${{ fromJson(needs.generate.outputs.diffs) }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "diff"
+
+      - uses: taiki-e/install-action@v2
+        if: matrix.needs_semver_checks
+        with:
+          tool: cargo-semver-checks
+
+      # if a new line is added here, make sure to update the `summary` job to reference the new step index
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: git-delta
+
+      - run: cargo regress diff ${{ matrix.command }} --use-pager-directly
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GITHUB_PR: ${{ matrix.pr }}
+          GIT_PAGER: delta --hunk-header-style omit
+  summary:
+    runs-on: ubuntu-latest
+    needs: [diff, generate]
+    if: always() && needs.generate.outputs.diffs != '{}' && needs.generate.outputs.diffs != '[]' && needs.generate.outputs.diffs != ''
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: |
+          PR_ID=$(echo "${{ github.event.comment.issue_url }}" | grep -o '[0-9]\+$')
+          gh run view ${{ github.run_id }} --json jobs | \
+          jq -r '"Diff for [comment]("+$comment+")\n\n" + ([.jobs[] | select(.name | startswith("diff")) | "- [" + (.name | capture("\\((?<name>[^,]+),.*") | .name) + "](" + .url + "?pr=" + $pr_id + "#step:7:45)"] | join("\n"))' --arg pr_id "$PR_ID" --arg comment "${{ github.event.comment.url }}"| \
+          gh pr comment "$PR_ID" --body "$(< /dev/stdin)"
+        env:
+          GH_TOKEN: ${{ github.token }}

.gitignore

@@ -3,4 +3,4 @@
 *.rs.bk
 *.svd
 target
-ci/svd2rust-regress/Cargo.lock
+output