Skip to content

Plugin quality check failure cases

Vincent Aranega edited this page Jun 12, 2023 · 3 revisions

The plugin quality checker can fail in some cases due to bad plugin metadata setup. This information also appears in the generated CSV under the Analysis Status column. These are listed here:

Case 1 - the plugin source repository URL is missing

If the plugin's python configuration files have no link to the source code of the project, then the project's GitHub repository can't be obtained from PyPI or the napari hub. In this case, a failure message is shown:

✗ Plugin 'plugin-name' does not have a repository URL on the napari hub platform

The value in the generated CSV is: MISSING_URL.

Case 2 - the plugin's source repository URL is inaccessible (likely private)

If the source code URL for the plugin links to a private GitHub repository, then the code can't be accessed. A failure message is shown:

✗ Repository URL for plugin 'plugin-name' is not accessible (private repository?) (url: 'URL')

The value in the generated CSV is: UNACCESSIBLE_REPOSITORY.

Case 3 - the plugin's source repository URL is ill-formatted

If the source code URL for the plugin is ill-formatted, a failure message is shown:

✗ Repository URL format for 'plugin-name' is wrong (url: 'URL')

The value in the generated CSV is: BAD_URL.

Case 4 - Plugin does not exists in the napari hub platform

If the plugin passed as argument of the tool cannot be found in the napari hub platform, a failure message is shown:

✗ Plugin is not existing in the napari hub platform

The value in the generated CSV is: NON_EXISTING_PLUGIN.