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

Clean up gRPC API for plugins #1001

Closed
4 of 5 tasks
Tracked by #840
huseyinbabal opened this issue Feb 28, 2023 · 1 comment
Closed
4 of 5 tasks
Tracked by #840

Clean up gRPC API for plugins #1001

huseyinbabal opened this issue Feb 28, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@huseyinbabal
Copy link
Contributor

huseyinbabal commented Feb 28, 2023

We accept slice of Config object for plugin initialization, but for the simplicity, it would be better to accept single config also we have plan to spinup dedicated plugin instances. They will definitely accept single config. We need to update config part to have only single config object per plugin source/executor config group.

  • Go through codebase and remove such possibility only for source plugin
  • Update development guide
  • Check examples in repository template

AC

  • Remove deprecated fields in gRPC API + Go code related to plugin communication (remove deprecated event, there's a message field)
    • remove slice of configs in favor of a single config
      • such thing will introduce inconsistency between source and executor plugin
  • Remove unused fields event.Event if there are any
  • Clean up the executor config if there are some outdated fields
  • Ensure tutorials, architecture, plugin docs, repository template are updated - it's about removing
  • Ensure @huseyinbabal blogpost is updated with new API? Or wait until we can safely release the updated API
  • Update example repository and make sure we use latest Botkube version in go.mod (and make sure it compiles)
@mszostok mszostok added this to the v0.19.0 milestone Mar 3, 2023
@pkosiec pkosiec added the enhancement New feature or request label Mar 7, 2023
@pkosiec pkosiec changed the title Accept single config for plugins Accept single config for source plugins Mar 7, 2023
@pkosiec pkosiec modified the milestones: v0.19.0, v0.20.0 Mar 7, 2023
@pkosiec pkosiec added the needs-triage Relates to issues that should be refined label Mar 7, 2023
@pkosiec pkosiec modified the milestones: v1.1.0, v1.2.0 May 11, 2023
@pkosiec pkosiec changed the title Accept single config for source plugins Clean up gRPC API for plugins May 23, 2023
@pkosiec pkosiec removed the needs-triage Relates to issues that should be refined label May 23, 2023
@mszostok mszostok modified the milestones: v1.1.0, v1.2.0 May 23, 2023
@pkosiec pkosiec modified the milestones: v1.2.0, v1.3.0 Jun 20, 2023
@pkosiec pkosiec modified the milestones: v1.3.0, v1.4.0 Jul 18, 2023
@pkosiec pkosiec modified the milestones: v1.3.0, v1.4.0 Aug 16, 2023
@mszostok mszostok self-assigned this Aug 17, 2023
@mszostok
Copy link
Contributor

template repo will be updated once a new tag will be released: #1192

the repo already uses the newest API so there won't be any more work required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

3 participants