Init this repo

[t-kikuc]

cf. pipe-cd/pipecd#5820

ToDo List

ASAP

• Init: Create an empty repo (this repo)

• Determine the directory structure

• Example:

  • Migrate the example plugin to the repo

• README for users

  • Config of the example plugin??
  • Link to plugins -> Unnecessary
  • Example Usage (pipe-cd/pipecd repo??)
    • -> manage in Init alpha usage of pipedv1 and plugins pipecd#5878

• CONTRIBUTING.md for contributors

  • Flow and requirements for adding a new plugin to the repo
    • Issue template
    • Who will determine the plugin dir?
    • PR template (by Makefile?)
    • add to CONTRIBUTING.md
  • Who will lead the maintenance of each plugin?
    • I want at least one person besides the PipeCD core maintainers
    • What if the maintenance became inactive? Change the maintainer? Deprecate the plugin? -> TBD
  • Review/merge rules
    • Define Who (Based on CODEOWNERS seems good)
    • How many reviews -> at first, one of CODEOWNERS?
      • -> One. we can define only one value for one repo.
    • Set the repo rule
    • add to CONTRIBUTING.md
  • Lifecycle of Code Owners
  • How to change the stability level

• CI

  • lint, build, test, security scanning...
    • Should test level depend on the plugin? -> Yes
  • DCO
  • Sync docs

Just before publish

• Release binaries of the example plugin

Later (rough at first)

• Release flow

  • When to trigger
  • Who triggers
  • Versioning (semver)
    • Independent versioning for each plugin?
    • How to manage version dependencies with PipeCD core/SDK
  • Create a GHA workflow
  • ChangeLog?

• How to handle docs for each plugin?

  • Where to write -> Each README?
  • What format to use?
    • Want to standardize how to document configuration fields and supported features

• Define Stability Levels (InDev/Alpha/Beta/Stable)

  • Define the criteria

• Standardize the docs/README format

  • cf. metadata.json https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/metadata-schema.yaml

• Issue templates (Bug, enhancement, new feature, )

• Put Issues/PRs a label automatically (e.g. plugin/example-stage, plugin/azure-function)

  • Issues -> GHA
  • PRs -> labeler

• security scanning in CI

• Report coverage in CI

• MergeQueue for secure and stable merge

• dependency updates (dependabot?)

• Define the rule for issue triage