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

✨ Enable users to integrate external checks via blank-imports #3809

Closed
wants to merge 3 commits into from

Conversation

johnandersen777
Copy link

@johnandersen777 johnandersen777 commented Jan 18, 2024

What kind of change does this PR introduce?

  • feat: expose checker registration
  • feat: enable checker go plugins
  • feat: docs for checker go plugins
  • feat: tests for checker go plugins
  • PR title follows the guidelines defined in our pull request documentation

What is the current behavior?

  • Checks must be added in tree within upstream scorecard repo

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

  • Plugins can be loaded by specifying a SCORECARD_DYNAMIC_CHECKS
    environment variable which leverages Golang plugins
  • Docs have been added
    • [ ]
  • Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

TODO

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.)

Check plugins using go plugins

@johnandersen777 johnandersen777 changed the title Checker plugins using go plugins ✨ Checker plugins using go plugins Jan 18, 2024
@johnandersen777 johnandersen777 changed the title ✨ Checker plugins using go plugins ✨ Check plugins using go plugins Jan 18, 2024
"strings"
)

const CheckDynamicPluginLocationEnvironmentVariable = "SCORECARD_DYNAMIC_CHECKS"
Copy link
Author

Choose a reason for hiding this comment

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

  • Rename to checks/plugins.go

Copy link
Member

@spencerschrock spencerschrock left a comment

Choose a reason for hiding this comment

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

We are trying to avoid using plugins for the reasons specified in #3095

@spencerschrock
Copy link
Member

cc @naveensrinivasan for possible coordination

@johnandersen777
Copy link
Author

Thanks @spencerschrock, so just to clarify focus of this PR would be on the check docs side of things?

@johnandersen777 johnandersen777 changed the title ✨ Check plugins using go plugins ✨ Enable users to integrate external checks via blank-imports Jan 18, 2024
@spencerschrock
Copy link
Member

Thanks @spencerschrock, so just to clarify focus of this PR would be on the check docs side of things?

There's still the aspect of the changes outlined in #3095, and the followup comment #3095 (comment).

Copy link

github-actions bot commented Feb 6, 2024

This pull request is stale because it has been open for 10 days with no activity

@github-actions github-actions bot added the Stale label Feb 6, 2024
@naveensrinivasan
Copy link
Member

I apologize for the delayed response. I will be working on this. Thanks!

@johnandersen777
Copy link
Author

johnandersen777 commented Feb 7, 2024 via email

@spencerschrock
Copy link
Member

Should I close this PR then?

I'm not sure about Naveen's expected timeline, but I'll go ahead and close this for now.
@naveensrinivasan can you update us if you dont end up pursuing this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants