Skip to content

Assign "other" request type for newline-only diffs #67

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

Merged
merged 2 commits into from
Aug 26, 2021
Merged

Assign "other" request type for newline-only diffs #67

merged 2 commits into from
Aug 26, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 26, 2021

In order to make the system as lenient as possible in regards to submission format, newline changes to the list are ignored (with the exception of final newline removal). For this reason, a PR consisting solely of changes to the newlines in the list results in a null list of URLs, as would be expected.

The problem was that these PRs were assigned a "modification" type. A workflow job matrix is used to check the list of URLs generated from a "modification" request "update" mode to see whether they are still compliant with the requirements in order to triage modification requests before the registry maintainer does the final manual review of the PR.

GitHub Actions does not allow zero length job matrices, and anyway this sort of PR does not match with the meaning we have assigned the "modification" type. The "other" type is most appropriate for this type of PR. "other" type requests are also manually reviewed, but without the automated triage which is not relevant to these requests.

The `testify` Go packages use the "Yoda condition"-style argument order: expected, actual. If the assertions reverse
the order of the arguments, the test failure output becomes very confusing.

Even though `assert.ElementsMatch()` doesn't treat the order of the arguments specially, it is best to be consistent
with the order.
In order to make the system as lenient as possible in regards to submission format, newline changes to the list are
ignored (with the exception of final newline removal). For this reason, a PR consisting solely of changes to the newlines
in the list results in a null list of URLs, as would be expected.

The problem was that these PRs were assigned a "modification" type. A workflow job matrix is used to check the list of
URLs generated from a "modification" request "update" mode to see whether they are still compliant with the requirements
in order to triage modification requests before the registry maintainer does the final manual review of the PR.

GitHub Actions does not allow zero length job matrices, and anyway this sort of PR does not match with the meaning we
have assigned the "modification" type. The "other" type is most appropriate for this type of PR. "other" type requests
are also manually reviewed, but without the automated triage.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: code Related to content of the project itself labels Aug 26, 2021
@per1234 per1234 requested a review from silvanocerza August 26, 2021 05:23
@codecov-commenter
Copy link

Codecov Report

Merging #67 (d404219) into main (86cc80c) will increase coverage by 0.52%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #67      +/-   ##
==========================================
+ Coverage   28.62%   29.15%   +0.52%     
==========================================
  Files           1        1              
  Lines         269      271       +2     
==========================================
+ Hits           77       79       +2     
  Misses        188      188              
  Partials        4        4              
Flag Coverage Δ
unit 29.15% <100.00%> (+0.52%) ⬆️

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

Impacted Files Coverage Δ
main.go 29.15% <100.00%> (+0.52%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 86cc80c...d404219. Read the comment docs.

Copy link

@rsora rsora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@per1234 per1234 merged commit 0de0b65 into arduino:main Aug 26, 2021
@per1234 per1234 deleted the blank-line-type branch August 26, 2021 10:19
@per1234 per1234 self-assigned this Nov 20, 2021
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.

4 participants