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

Include plugin health score in Pipeline steps reference #181

Open
MarkEWaite opened this issue Jan 20, 2023 · 5 comments
Open

Include plugin health score in Pipeline steps reference #181

MarkEWaite opened this issue Jan 20, 2023 · 5 comments

Comments

@MarkEWaite
Copy link

I think that users of the Pipeline Steps reference pages (like docker compose build step) would benefit if the top of the page included the plugin health score as either a badge or a visible number. That would help users of the specific Pipeline steps understand if they are using a plugin that is unmaintained or otherwise unhealthy.

The docker compose build step (as an example) has a surprisingly high score (96) for a plugin that has had only one release and that single release was 5 years ago with documentation from the Jenkins wiki export. Likely that we need more components in the health score in order to more accurately reflect the lower score that type of plugin should receive.

@alecharp
Copy link
Collaborator

The docker compose build step (as an example) has a surprisingly high score (96) for a plugin that has had only one release and that single release was 5 years ago with documentation from the Jenkins wiki export. Likely that we need more components in the health score in order to more accurately reflect the lower score that type of plugin should receive.

I agree. We need to refine the scoring process or create a new one now that we have the Jenkins Core version requirement, the installation count, etc. cc @jleon33

@Jagrutiti
Copy link
Member

Is this a beginner-friendly issue?

@MarkEWaite
Copy link
Author

Is this a beginner-friendly issue?

I don't think this is a good first issue yet. Once the health scores can be downloaded from the plugin health scoring system, it might be a good first issue.

The majority of the changes to implement this will be in the Pipeline steps doc generator and possibly in the Pipeline metadata utils, not in the plugin health score repository. Those tools will need to be enhanced to read the plugin health score data and insert the scores into the page layout of each of the pipeline steps pages in a way that is visually pleasing.

@Jagrutiti
Copy link
Member

Could you tell me a beginner-friendly issue in this repository?

@MarkEWaite
Copy link
Author

I don't see any issues in the repository currently that I would consider good first issues.

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

No branches or pull requests

3 participants