Skip to content

feat(scorecard): Implement batch provider for file checks#1

Merged
djanickova merged 7 commits intoscorecard-file-level-checksfrom
scorecard-batch-provider
Mar 20, 2026
Merged

feat(scorecard): Implement batch provider for file checks#1
djanickova merged 7 commits intoscorecard-file-level-checksfrom
scorecard-batch-provider

Conversation

@djanickova
Copy link
Copy Markdown
Owner

@djanickova djanickova commented Feb 24, 2026

Implement batch provider for file checks

This PR introduces a batch provider for file checks in scorecard. I took most of the logic from Patrick's POC (thanks again!), adjusted it and updated tests and the README file. The provider logs the values for now for testing purposes. When you test the PR locally, you can check the logs to verify that the values are correct.

This PR does not contain any frontend changes or changes to the aggregated metrics card, I will do this in a separate PR. This means that if you test these changes locally, the cards will not be showing up correctly in the UI, example here:
Screenshot 2026-02-23 at 19 38 31

An example of a config for local testing:

scorecard:
  plugins:
    github:
      files_check:
        files:
          - readme-correct: "README.md"
          - i18guide-correct: "docs/backstage-i18n-guide.md"
          - readme-incorrect: "./README.md"
          - i18guide-incorrect: "/docs/backstage-i18n-guide.md"
        schedule:  # Now works! Matches provider ID "github.files_check"
          frequency: { minutes: 5 }
          timeout: { minutes: 10 }
          initialDelay: { seconds: 5 }

Example of a console log for fetched data:
Screenshot 2026-02-23 at 15 59 10

So to summarize, the changes that will be added in a future PR will include:

  • frontend changes
  • any changes needed for the aggregated metrics card
  • e2e tests
  • changesets

I'll be happy for any feedback, thank you in advance!

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or Updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

Signed-off-by: Diana Janickova <djanicko@redhat.com>
Assisted-By: Cursor
Signed-off-by: Diana Janickova <djanicko@redhat.com>
Signed-off-by: Diana Janickova <djanicko@redhat.com>
@djanickova djanickova marked this pull request as ready for review February 24, 2026 13:15
djanickova and others added 4 commits March 19, 2026 12:06
Signed-off-by: Diana Janickova <djanicko@redhat.com>
Co-authored-by: Ihor Mykhno <imykhno@redhat.com>
Signed-off-by: Diana Janickova <djanicko@redhat.com>
Signed-off-by: Diana Janickova <djanicko@redhat.com>
@djanickova djanickova requested a review from imykhno March 19, 2026 11:43
Copy link
Copy Markdown
Collaborator

@imykhno imykhno left a comment

Choose a reason for hiding this comment

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

Thank you! I have tested this locally with various files—including README.md, LICENSE, and CODEOWNERS— and configured the schedule for the files_check metrics. I can confirm that the functionality works as expected.

@djanickova djanickova merged commit bdb9d29 into scorecard-file-level-checks Mar 20, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants