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

Update package-list.json to add Kafka Connect Provider #6456

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

azaurus1
Copy link
Contributor

@azaurus1 azaurus1 commented Jan 18, 2025

Description

This PR is for adding the Kafka Connect provider to the Pulumi Registry, this allows users to create, read and delete Kafka Connect Connectors, Supports:

  • JavaScript/TypeScript
  • Python
  • Go
  • .NET

Adding a new package?

If this pull request adds a new package, please verify/document:

  • The primary maintainer contact for this package (please indicate if the provider is sponsored by a company or community maintained)
  • The package's schema URL in this PR is correct.
  • The package metadata file, if present, contains:
    • a supported category (one of Cloud, Infrastructure, Network, Database, Monitoring, or Utility).
    • a valid plugin download URL. See Publish Your Package.
    • a description that explains what the package does.
    • a valid logo URL that points to a PNG whose dimensions conform to the others in this repo (e.g., 100x100).
  • The package repo contains an Overview doc (/docs/_index.md) that includes:
    • a brief explanation of what the package is and what it does.
    • at least one representative example in all supported languages (i.e. TypeScript, Python, Go and C#).
    • a front-matter property for the layout set to package.
  • The package repo contains an Installation and Configuration doc (/docs/installation-configuration.md) that includes:
    • links to SDKs in all supported languages (i.e. should link to published SDKs in NPM, PyPi and NuGet).
    • a copyable command for installing the resource plugin if necessary.
    • an example of configuring the provider with pulumi config set.
    • an example of configuring the provider with environment variables.
  • The repository has:
    • a version tag prefixed with v that corresponds with a valid GitHub release and published package SDKs (in NPM, PyPi, and NuGet)
  • A CODEOWNER has reviewed the PR.
  • A member of the @pulumi/docs team has reviewed all documentation.

Thanks

@azaurus1 azaurus1 marked this pull request as ready for review January 18, 2025 02:05
@azaurus1 azaurus1 requested review from sean1588 and a team as code owners January 18, 2025 02:05
@azaurus1 azaurus1 changed the title Update package-list.json Update package-list.json to add Kafka Connect Provider Jan 20, 2025
@mjeffryes
Copy link
Member

mjeffryes commented Jan 22, 2025

Thanks for the contribution @azaurus1! Overall the new provider looks pretty good, just a couple minor nits:

  1. It looks like some of the examples have the wrong imports:
    https://github.com/azaurus1/pulumi-kafka-connect/blob/1ffeccfb0f093a6b2d784e907fe3fa89af91761e/examples/nodejs/index.ts#L2
    should be importing @azaurus1/kafkaconnect
    https://github.com/azaurus1/pulumi-kafka-connect/blob/1ffeccfb0f093a6b2d784e907fe3fa89af91761e/examples/dotnet/Program.cs#L4
    should be importing Azaurus1.Kafkaconnect

  2. The schema is missing a logoUrl
    (Here's an example from one of our providers:
    https://github.com/pulumi/pulumi-command/blob/2347595642dab607646d3ac4c2d941ebd03223d9/provider/pkg/provider/provider.go#L47)

@mjeffryes mjeffryes added the awaiting-feedback Blocked on input from the author label Jan 22, 2025
@azaurus1
Copy link
Contributor Author

@mjeffryes Thanks, I will make these changes shortly and update you here

@azaurus1
Copy link
Contributor Author

@mjeffryes those changes have been made:

  • node example is now importing the correct package @azaurus/kafkaconnect (NPM module is under azaurus)
  • dotnet example is now importing Azaurus1.Kafkaconnect
  • LogoURL has been added to the metadata within provider.go

Copy link
Member

@mjeffryes mjeffryes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I'll go ahead and approve the PR. Could you please make a a v0.0.8 release so that we can pick up the logo when this merges?

@azaurus1
Copy link
Contributor Author

Done, v0.0.8 released and published

@mjeffryes mjeffryes merged commit dd5f343 into pulumi:master Jan 23, 2025
8 checks passed
@iwahbe iwahbe removed the awaiting-feedback Blocked on input from the author label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants