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

Make the manager field on a plugin object optional #191

Open
Callum027 opened this issue Mar 15, 2024 · 0 comments
Open

Make the manager field on a plugin object optional #191

Callum027 opened this issue Mar 15, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request pipeline CI pipeline-related issue or pull request
Milestone

Comments

@Callum027
Copy link
Member

Callum027 commented Mar 15, 2024

At the moment, an implementation of the Manager class must be defined in a plugin class.

manager: Type[ManagerPlugin]
"""
Manager class for the plugin.
Buildarr instantiates an object of this class without any arguments, and
runs operations on configurations and secrets metadata through the methods
defined in this class.
"""

In practice, however, all of the existing managers within plugins are subclasses of the ManagerPlugin class without overriding any of the existing methods, since ManagerPlugin provides methods that hook into corresponding methods on the ConfigPlugin and SecretsPlugin classes.

Make it so that, similar to the cli field, plugins can simply specify None here (or leave it completely undefined), and Buildarr will use the ManagerPlugin class's base methods unmodified.

@Callum027 Callum027 added enhancement New feature or request pipeline CI pipeline-related issue or pull request labels Mar 15, 2024
@Callum027 Callum027 added this to the v0.8.0 milestone Mar 15, 2024
@Callum027 Callum027 self-assigned this Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pipeline CI pipeline-related issue or pull request
Projects
None yet
Development

No branches or pull requests

1 participant