improve regress

[Emilgardis]

Beginning of revamp for our CI

This pr adds the following new features

• Makes it possible to specifically single out a chip and have tests/diff always be run for it
• Allow passing any command to svd2rust via svd2rust-regress tests -- --command
• Add alias cargo regress -> cargo run -p svd2rust-regress --
• Allow diffing two versions of the output
  This allows for diffing between svd2rust versions and command inputs

  # diff the output between master branch without any extra args and this pr with --atomics
  svd2rust-regress diff --baseline "" --current "--atomics" --chip my-chip
  # diff the output of master branch and this pr 
  svd2rust-regress diff --baseline "@master" --current "@pr" --chip my-chip
  # shorthand for above with a well-known default chip
  svd2rust-regress diff pr

  where @pr = version from current pr, @master = version from master branch
• Add a on_comment hook to allow diffing prs

  /ci diff pr
  

  /ci diff -c achipwewanttodiff -- --atomics
  

  this should output the result in a <details> or gist

resolves #355

[burrbull]

Nice!

[burrbull]

we need to add retry for curl
https://stackoverflow.com/questions/42873285/curl-retry-mechanism

[Emilgardis]

added no changelog just to make ci happy for now

[burrbull]

What status of this?

[Emilgardis]

I still want to implement it, just don't have the time or motivation right now

[Emilgardis]

Header text

Diff result (click to expand)

diff --git "a/.\\output\\head\\atmel_at91sam9cn11\\/src/lib.rs" "b/.\\output\\base\\atmel_at91sam9cn11\\/src/lib.rs"
index 4fe602c..b31966b 100644
--- "a/.\\output\\head\\atmel_at91sam9cn11\\/src/lib.rs"
+++ "b/.\\output\\base\\atmel_at91sam9cn11\\/src/lib.rs"
@@ -1,4 +1,4 @@
-/*!Peripheral access API for AT91SAM9CN11 microcontrollers (generated using svd2rust v0.31.2 (99e68c7 2023-11-29))
+/*!Peripheral access API for AT91SAM9CN11 microcontrollers (generated using svd2rust v0.31.2 (ef9b813 2023-11-29))

 You can find an overview of the generated API [here].

[Emilgardis]

it's now possible to do

cargo regress diff --format --base "@v0.30.3" --head "@v0.31.2"
cargo regress diff --format --head "@debug"

etc.

i have one problem with this though, the diff is way to large to be always useful. I think it would be helpful to have a very small default example case that is expected to only emit few changes. Maybe we could even make a query somehow to specify something like "I only want the diff inside mod clusterb"

[Emilgardis]

https://github.com/Emilgardis/svd2rust/actions/runs/7079947413/job/19267177832?pr=1#step:7:45 feedback appreciated!

[Emilgardis]

switched to yaml!
Any opinions on the diff? I think I want it in another way, and having it be saved elsewhere other than action logs would be nice, but I don't think a comment works for it and there's no way to create a gist using an organization account (we'd need a rust-embedded bot account)

[burrbull]

Any opinions on the diff? I think I want it in another way, and having it be saved elsewhere other than action logs would be nice, but I don't think a comment works for it and there's no way to create a gist using an organization account (we'd need a rust-embedded bot account)

Need someone more powerful. cc @therealprof @adamgreig

[burrbull]

@Emilgardis I've made several fixes. See #782

[Emilgardis]

this needs to check that generate.outputs.diffs was not empty, otherwise a comment will always be done: Emilgardis#1 (comment)

[burrbull]

Maybe it is better to merge this PR and make future changes in new PRs?

[Emilgardis]

I think that's fine, I'll cleanup the commits and do the last adjustments before a review to merge

[Emilgardis]

managed to sneak in a bug during the rebase and implementing regress pr, should be all good now.

[Emilgardis]

🥳

[Emilgardis]

/ci diff pr

lets try it :)

[github-actions]

Diff for comment

• pr

[Emilgardis]

well it works, but it doesn't like the command , will fix