Fix plugin manifest#126
Merged
Merged
Conversation
Collaborator
C-Achard
commented
May 21, 2026
- Fix plugin manifest to use hyphenated package name
- Add npe2 validation in CI before deploy
Replace underscore-separated plugin identifiers with hyphen-separated ones. Rename the manifest name to "napari-cellseg3d" and update all command IDs and widget command references in napari_cellseg3d/napari.yaml. Update pyproject.toml to register the manifest under [project.entry-points."napari.manifest"] with key "napari-cellseg3d" -> "napari_cellseg3d:napari.yaml" so the manifest and entry-point names are consistent.
Install npe2 in the test workflow and run a plugin validation step before building the package. This ensures napari_cellseg3d/napari.yaml is validated (via `python -m npe2 validate`) as part of CI to catch plugin metadata issues early.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the napari plugin manifest metadata with the project’s hyphenated distribution name and adds CI validation to catch manifest issues prior to publishing.
Changes:
- Fix
pyproject.tomlnapari manifest entry-point declaration and use the hyphenated entry-point name (napari-cellseg3d). - Update
napari_cellseg3d/napari.yamlpluginnameand all command/widget IDs to the hyphenated prefix. - Add an
npe2validation step to the deploy workflow before building and uploading to PyPI.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
pyproject.toml |
Corrects the napari.manifest entry-point table and switches the entry-point name to napari-cellseg3d. |
napari_cellseg3d/napari.yaml |
Renames the plugin and command/widget identifiers to the hyphenated plugin name for consistency with packaging. |
.github/workflows/test_and_deploy.yml |
Installs npe2 and runs npe2 validate before build/publish to prevent shipping an invalid manifest. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.