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

Rename dummy plugin to "example" plugin that is used within docs and core test suite #443

Closed
jathanism opened this issue May 13, 2021 · 5 comments
Assignees
Labels
good first issue Great issues for newcomers! type: housekeeping Changes to the application which do not directly impact the end user
Milestone

Comments

@jathanism
Copy link
Contributor

jathanism commented May 13, 2021

Proposed Changes

We already did the work to break out nautobot.extras.tests.dummy_plugin and its corresponding parts to the examples directory in the project root so that it is installed like a normal plugin would be and included as a dependency in pyproject.toml.

Justification

The name "Dummy" makes it seem like it doesn't do anything, but we should rename it to "Example" so it indicates more clearly that it is actually a reference example of an actual plugin, that exercises most of the available features.

This will set us up for the future to continue to extend and test plugin features while also showcasing them explicitly as examples.

@glennmatthews
Copy link
Contributor

While I agree with splitting the plugin out into a proper Python package, I'm leaning a bit towards keeping it as a separate subdirectory (/examples/dummy_plugin/?) in the main repository rather than creating a separate repository. My reasoning is just that in most cases the dummy plugin should be versioned in lockstep with Nautobot itself, rather than having separate releases. Open to discussion on this point though.

@glennmatthews glennmatthews reopened this May 13, 2021
@glennmatthews glennmatthews added the type: housekeeping Changes to the application which do not directly impact the end user label May 13, 2021
@FragmentedPacket
Copy link
Contributor

I agree with @GlennMatthew, but not entirely sure how it'll work with tests.

This is a good thing to fix though as I ran into issues testing in #395 so thanks for creating this issue!

@glennmatthews
Copy link
Contributor

@jathanism Is this resolved by #474?

@jedelman8 jedelman8 changed the title Break out dummy plugin into its own public repo as a "kitchen sink" Nautobot app Rename dummy plugin to "example" plugin that is used within docs and core test suite Sep 17, 2021
@jathanism
Copy link
Contributor Author

I just reworked this to rename the plugin and enhancing the documentation instead of publishing it to PyPI.

@glennmatthews
Copy link
Contributor

Implemented in next (1.3.0) by #1235.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Great issues for newcomers! type: housekeeping Changes to the application which do not directly impact the end user
Projects
No open projects
Archived in project
Development

No branches or pull requests

5 participants