-
Notifications
You must be signed in to change notification settings - Fork 480
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
🌱 Migrate Maintained check to probes #3507
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AdamKorcz
requested review from
azeemshaikh38,
justaugustus,
laurentsimon,
naveensrinivasan,
spencerschrock and
raghavkaul
as code owners
September 22, 2023 15:30
AdamKorcz
temporarily deployed
to
integration-test
September 22, 2023 15:30
— with
GitHub Actions
Inactive
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3507 +/- ##
==========================================
- Coverage 76.13% 70.59% -5.54%
==========================================
Files 205 209 +4
Lines 14068 14217 +149
==========================================
- Hits 10711 10037 -674
- Misses 2725 3592 +867
+ Partials 632 588 -44 |
probes/activityOnIssuesByCollaboratorsMembersOrOwnersInLast90Days/def.yml
Outdated
Show resolved
Hide resolved
probes/activityOnIssuesByCollaboratorsMembersOrOwnersInLast90Days/impl.go
Outdated
Show resolved
Hide resolved
AdamKorcz
temporarily deployed
to
integration-test
September 29, 2023 10:48
— with
GitHub Actions
Inactive
AdamKorcz
had a problem deploying
to
integration-test
October 3, 2023 14:37
— with
GitHub Actions
Failure
AdamKorcz
had a problem deploying
to
integration-test
October 3, 2023 14:38
— with
GitHub Actions
Failure
AdamKorcz
had a problem deploying
to
integration-test
October 3, 2023 14:41
— with
GitHub Actions
Failure
Stale pull request message |
AdamKorcz
force-pushed
the
maintained-probe
branch
from
October 31, 2023 11:46
160c36b
to
d7938f4
Compare
AdamKorcz
temporarily deployed
to
integration-test
October 31, 2023 11:47
— with
GitHub Actions
Inactive
AdamKorcz
temporarily deployed
to
integration-test
October 31, 2023 11:57
— with
GitHub Actions
Inactive
AdamKorcz
temporarily deployed
to
integration-test
October 31, 2023 12:44
— with
GitHub Actions
Inactive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
main blocker is the finding repetition vs value fields. happy to discuss in slack as well
AdamKorcz
temporarily deployed
to
integration-test
November 16, 2023 22:51
— with
GitHub Actions
Inactive
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
…st90Days' to 'issueActivityByProjectMember' Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
…tedWithinThreshold' Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
Signed-off-by: AdamKorcz <[email protected]>
AdamKorcz
force-pushed
the
maintained-probe
branch
from
November 16, 2023 22:51
c383c52
to
25b079d
Compare
AdamKorcz
temporarily deployed
to
integration-test
November 16, 2023 22:52
— with
GitHub Actions
Inactive
laurentsimon
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Feature.
(Is it a bug fix, feature, docs update, something else?)
What is the current behavior?
What is the new behavior (if this is a feature change)?**
This rewrites the Maintained check to four different probes:
archived
: Checks whether a project is archived.activityOnIssuesByCollaboratorsMembersOrOwnersInLast90Days
: Checks whether project collaborators, members or owners have participated in issues in the last 90 days.commitsInLast90Days
: Checks whether the project has had any commits by any user type in the last 90 days.wasCreatedInLast90Days
: Checks whether the project was created in the last 90 days.Put together, these four probes do the same checks as the current Maintained check. There should not be change in scoring, but the unit tests for the Maintained check and evaluation was not extensive, so this requires a review.
A few good-to-knows about the probes:
The outcome of
archived
may confuse some users: If the project is archived, the outcome is negative, because it is a negative factor. Some users may expect that a negative outcome means "no: The project is not archived".I believe
commitsInLast90Days
andactivityOnIssuesByCollaboratorsMembersOrOwnersInLast90Days
are the first probes to return a numeric value instead oftrue
/false
. However, there are no changes to the internals of Scorecard, since each probe is already designed to return a slice instead of a single finding.The probes are named according to the time they check.
The current Maintained check is not completely aligned with the documentation. For example, the documentation specifies that Maintained checks for commits every week whereas this is not the case in the implementation. The implementation checks that the contributions on average equal one contribution per week. This PR does NOT fix that, and I argue this PR should not fix that, since there are some considerations to make about the scoring.
Does this PR introduce a user-facing change?
No
For user-facing changes, please add a concise, human-readable release note to
the
release-note