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

fix: consistent boards list ordering #2025

Merged
merged 1 commit into from
Jan 4, 2023

Conversation

Bikappa
Copy link
Contributor

@Bikappa Bikappa commented Jan 4, 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)

What kind of change does this PR introduce?

Makes the board listall command output order consistent across formats. The list items are ordered by the package and platforms names they belong too, other than the board names themselves.
The plain text format remains an exception to this as it's sorted alphabetically by board name.

What is the current behavior?

In output formats other than plain text the board list is inconsistently ordered: while the boards within a single package/platform are ordered alphabetically they might appear before or after the ones of an other package/platform.

What is the new behavior?

The list is ordered by package, platform and board names.

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

No

Other information

Fixes #1909, although ordering between plain text and other formats remains different

@codecov
Copy link

codecov bot commented Jan 4, 2023

Codecov Report

Base: 36.53% // Head: 36.51% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (81d6fd8) compared to base (558130b).
Patch coverage: 0.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2025      +/-   ##
==========================================
- Coverage   36.53%   36.51%   -0.03%     
==========================================
  Files         228      228              
  Lines       19294    19316      +22     
==========================================
+ Hits         7050     7053       +3     
- Misses      11413    11433      +20     
+ Partials      831      830       -1     
Flag Coverage Δ
unit 36.51% <0.00%> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
commands/board/listall.go 0.00% <0.00%> (ø)
arduino/cores/packagemanager/package_manager.go 66.58% <0.00%> (+0.75%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Bikappa Bikappa requested a review from cmaglie January 4, 2023 12:40
@Bikappa Bikappa force-pushed the fix/consistent-boards-list-order branch from d3c3ef6 to 81d6fd8 Compare January 4, 2023 12:40
@Bikappa Bikappa marked this pull request as ready for review January 4, 2023 12:41
@Bikappa Bikappa merged commit 38a0dfd into master Jan 4, 2023
@Bikappa Bikappa deleted the fix/consistent-boards-list-order branch January 4, 2023 14:47
@per1234 per1234 added topic: code Related to content of the project itself type: imperfection Perceived defect in any part of project labels Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please make the output of the board listall --format json deterministic
3 participants