jenkins-infra / plugin-health-scoring

This project aims to introduce a metric system to calculate the health score of each plugin within the Jenkins ecosystem and reflect the final scores on the Plugin Site for the plugin maintainers and users.
https://plugin-health.jenkins.io
MIT License
24 stars 46 forks source link

Elastic axis score incorrectly says docs not in GitHub repo #285

Closed MarkEWaite closed 1 year ago

MarkEWaite commented 1 year ago

Description of the bug

https://plugin-health.jenkins.io/scores/elastic-axis shows the "Documentation is not located in the plugin repository" even though the plugins site shows the documentation from the README.md in the plugin repository

alecharp commented 1 year ago

Thank you for reporting this! The problem seems to be that, the link to the documentation has a / at the end of the url. Because of this

https://github.com/jenkins-infra/plugin-health-scoring/blob/b9133e157595e367696a390599847919f92f8b61/core/src/main/java/io/jenkins/pluginhealth/scoring/probes/DocumentationMigrationProbe.java#L51

is false, as the scm doesn't include that /.

This lead me to think that other plugins, using a more precise URL for the documentation (with a folder or a branch) won't work either.

Looking into this.