vote: A new repository for creating framework for notation plugin

[priteshbandi]

Hi @notaryproject/notaryproject-governance-maintainers ,
To simplify the creation of notation-plugin and as per discussion in the last community meeting(07/17), I would like to propose the creation of a new repository which will contain plugin base or framework code.

1. This would house code similar to https://github.com/priteshbandi/notation-plugin-base code but with removed dependency on cobra and some other improvements.
2. It will also contain an example plugin implementation, similar to https://github.com/priteshbandi/notation-plugin-base/tree/main/exampleplugin
3. After the creation of this pkg, notation-go will also be modified to take a dependency on newly created interfaces and structs so that we don't have to maintain duplicate code.

This way users will only need to maintain one implementation of the plugin and that can be used as both library and executable.

I am proposing the name of the new repository to be notation-plugin-framework-go but open to suggestions

@notaryproject/notaryproject-governance-maintainers If you agree with creating a new repository for the Notation Plugin Base/Framework, please comment LGTM below.

Thanks!

[shizhMSFT]

Since this plugin framework is for golang, should the repo name have a suffix -go?

[priteshbandi]

Since this plugin framework is for golang, should the repo name have a suffix -go?

Good point, updated the recommended name to notation-plugin-framework-go

[sajayantony]

/LGTM.
But IANAM.

[SteveLasker]

LGtM

[rgnote]

LGTM

[gokarnm]

LGTM!

[iamsamirzon]

What benefits will this repo provide? Is it just a framework with sample code or an actual repository for approved plugins ?

[yizha1]

I have a similar question as @iamsamirzon. What is the problem that this framework is going to solve? Do we have a real case where users couldn't solve the problem using existing framework, or is it purely code refactoring for simplicity and code maintenance?

[FeynmanZhou]

Will this notation-plugin-framework-go repo be a sample Notation plugin implementation for plugin developers? Is the purpose of this repo to lower the barrier to develop a plugin?

@zosocanuck is requesting a dedicated Plugin Developer documentation with reference implementations in select languages such as Golang, .NET, etc. as described in notaryproject/notaryproject.dev#305.
@priteshbandi Do you think this notation-plugin-framework-go will be beneficial for @zosocanuck's request?

[shizhMSFT]

LGTM

[priteshbandi]

@iamsamirzon
What benefits will this repo provide? Is it just a framework with sample code or an actual repository for approved plugins ?

This will remove cross-cutting concerns for plugin implementers like exposing cli, duplicating structs, having implementation which can be used to generate executable and as a plugin library in notation-go.
Also, we will be providing an example plugin, which will serve as a reference for new implementers.

---

@yizha1
I have a similar question as @iamsamirzon. What is the problem that this framework is going to solve? Do we have a real case where users couldn't solve the problem using existing framework, or is it purely code refactoring for simplicity and code maintenance?

It is indeed solving real usecase, look at https://cloud-native.slack.com/archives/CQUH8U287/p1689247327932749 thread with 40 replies, having well defined interface to work with and a reference implementation would have helped. For benefits, please look at the reply to Samir's question.

---

@FeynmanZhou
Will this notation-plugin-framework-go repo be a sample Notation plugin implementation for plugin developers? Is the purpose of this repo to lower the barrier to develop a plugin?

It'll be both (see reply to Samir's and Yi's question.

@priteshbandi Do you think this notation-plugin-framework-go will be beneficial for @zosocanuck's request?

It will help with some of the painpoints pointed out in notaryproject/notaryproject.dev#305.

[yizha1]

Thanks @priteshbandi

LGTM

[yizha1]

Close as completed.