Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make boards details JSON output deterministic #2419

Conversation

alessio-perugini
Copy link
Contributor

@alessio-perugini alessio-perugini commented Nov 14, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Make programmers and build_properties deterministic in JSON output.

What is the current behavior?

Now when performing arduino-cli boards details ... it produces a JSON that has some fields that contain values that are always randomly sorted.

What is the new behavior?

Now the arduino-cli boards details ... output produces a JSON that is always deterministic. No more randomly sorted values in arrays 🤘

Does this PR introduce a breaking change, and is titled accordingly?

Other information

@alessio-perugini alessio-perugini added this to the Arduino CLI v0.36.0 milestone Nov 14, 2023
@alessio-perugini alessio-perugini added the type: enhancement Proposed improvement label Nov 14, 2023
@alessio-perugini alessio-perugini self-assigned this Nov 14, 2023
@alessio-perugini alessio-perugini linked an issue Nov 14, 2023 that may be closed by this pull request
3 tasks
Copy link

codecov bot commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3d88eff) 67.25% compared to head (6b6f7a1) 67.16%.
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2419      +/-   ##
==========================================
- Coverage   67.25%   67.16%   -0.09%     
==========================================
  Files         210      210              
  Lines       20543    20539       -4     
==========================================
- Hits        13817    13796      -21     
- Misses       5591     5603      +12     
- Partials     1135     1140       +5     
Flag Coverage Δ
unit 67.16% <100.00%> (-0.09%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alessio-perugini alessio-perugini marked this pull request as ready for review November 14, 2023 10:56
@alessio-perugini alessio-perugini merged commit 354464f into master Nov 14, 2023
194 checks passed
@alessio-perugini alessio-perugini deleted the 2209-please-make-the-json-output-of-board-details-deterministic branch November 14, 2023 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please make the JSON output of board details deterministic
2 participants