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

🌱 sort organizations in Contributors detail string #4436

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

spencerschrock
Copy link
Member

What kind of change does this PR introduce?

cleanup for scdiff

What is the current behavior?

The orgs are printed in map iteration order (random), and there's a lot of duplication in the text:

Info: CatalystCode contributor org/company found, microsoft corporation contributor org/company found,
    python-trio contributor org/company found, googlers contributor org/company found,
    Azure-Samples contributor org/company found, microsoft contributor org/company found,
    syncweek-react-aad contributor org/company found, webhintio contributor org/company found,
    IPPETAD contributor org/company found, projectkudu contributor org/company found,
    Azure contributor org/company found,

specifically with iteration order, this creates noisy scdiff diffs where the only difference is the order:

-                                                       "eclipse",
+                                                       "jacoco",
                                                        " contributor org/company found, ",
-                                                       "mtrail gmbh",
+                                                       "SonarQubeCommunity",
                                                        " contributor org/company found, ",
-                                                       "jenkinsci",
+                                                       "1and1",
                                                        " contributor org/company found, ",
-                                                       "1and1",
+                                                       "dsmHack",
                                                        " contributor org/company found, ",
-                                                       "op",
                                                        "e",
-                                                       "njdk contributor org/company found, apache contributor org/compa",
-                                                       "ny found, SonarSource",
+                                                       "clipse contributor org/company found, SonarSource contributor or",
+                                                       "g/company found, sardinella",
                                                        " contributor org/company found, ",
-                                                       "SonarQubeCommunity",
+                                                       "mtrail gmbh",
                                                        " contributor org/company found, ",
-                                                       "eclipse-eclemma",
+                                                       "apache",
                                                        ... // 182 identical, 136 removed, and 144 inserted bytes

What is the new behavior (if this is a feature change)?**

The strings are sorted, which will help create less noisy diffs when running scdiff (like during the release process).
Removed the duplicated "contributor org/company found" text which made the output long:

Info: found contributions from: Azure, Azure-Samples, CatalystCode,
    IPPETAD, googlers, microsoft, microsoft corporation,
    projectkudu, python-trio, syncweek-react-aad, webhintio
  • Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

Special notes for your reviewer

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to
the release-note

(In particular, describe what changes users might need to make in their
application as a result of this pull request.)

Lexicographically sorted contributing organizations in the Contributors check and cleaned up duplication.

removes duplicated company found words, and sorted the output. the sorting is aimed at supporting cleaner diffs for scdiff.

Signed-off-by: Spencer Schrock <[email protected]>
@spencerschrock
Copy link
Member Author

/scdiff generate Contributors

Copy link

github-actions bot commented Dec 4, 2024

Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.54%. Comparing base (353ed60) to head (fd717b2).
Report is 71 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4436      +/-   ##
==========================================
+ Coverage   66.80%   68.54%   +1.73%     
==========================================
  Files         230      240      +10     
  Lines       16602    17882    +1280     
==========================================
+ Hits        11091    12257    +1166     
- Misses       4808     4823      +15     
- Partials      703      802      +99     

Copy link
Member

@justaugustus justaugustus left a comment

Choose a reason for hiding this comment

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

Thanks @spencerschrock!

@justaugustus justaugustus merged commit 687b739 into ossf:main Dec 10, 2024
41 checks passed
@spencerschrock spencerschrock deleted the contributors branch December 10, 2024 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants