Adding github action to validate contextual survey json

flutter / uxr

UXR work for Flutter

BSD 3-Clause "New" or "Revised" License

227 stars 28 forks source link

Adding github action to validate contextual survey json #104

Closed eliasyishak closed 1 year ago

eliasyishak commented 1 year ago

Reference issue:

https://github.com/dart-lang/tools/issues/81

This will add validation for the json file to ensure the data is correct

Pre-launch Checklist

[x] I read the Contributor Guide and followed the process outlined there for submitting PRs.
[x] I read the Tree Hygiene wiki page, which explains my responsibilities.
[x] I read the Flutter Style Guide recently, and have followed its advice.
[x] I signed the CLA.
[x] I listed at least one issue that this PR fixes in the description above.
[x] I updated/added relevant documentation (doc comments with ///).
[x] I added new tests to check the change I am making, or this PR is test-exempt.
[x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

eliasyishak commented 1 year ago

@jayoung-lee whenever you get a chance to review, this PR will essentially ensure that future updates to the context survey json will be valid and won't break package:unified_analytics

parlough commented 1 year ago

As for the analysis question:

I would probably add it as a separate job in the same file, so it doesn't ever block the actual validation. Would something like this work?

  analyze:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: surveys/validator
    steps:
      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
      - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
      - name: Verify formatting
        run: dart format --output=none --set-exit-if-changed .
      - name: Analyze Dart files
        run: dart analyze --fatal-infos

parlough commented 1 year ago

I accidentally deleted your comment. I'm so sorry...I meant to delete one of mine. 🙇

Thanks for addressing my comments, I appreciate it!

eliasyishak commented 1 year ago

As for the analysis question:

I would probably add it as a separate job in the same file, so it doesn't ever block the actual validation. Would something like this work?

  analyze:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: surveys/validator
    steps:
      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
      - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
      - name: Verify formatting
        run: dart format --output=none --set-exit-if-changed .
      - name: Analyze Dart files
        run: dart analyze --fatal-infos

Yep! This seems to work as expected, and looks like both jobs ran in my latest commit