Validate the Defang Provider for the Registry #6983
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Your site preview for commit b74b25f is ready! 🎉 http://registry--origin-pr-6983-b74b25f1.s3-website.us-west-2.amazonaws.com/registry. |
iwahbe
changed the title
iwahbe
force-pushed
the
iwahbe/validate-defang
branch
from
b74b25f to
ce57f1d
Compare
|
Your site preview for commit ce57f1d is ready! 🎉 http://registry--origin-pr-6983-ce57f1d6.s3-website.us-west-2.amazonaws.com/registry. |
|
Site previews for this pull request have been removed. ✨ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For maintainers
To keep quality in the Pulumi Registry high, we have a check-list before merging a new provider into the registry. Please post a copy of this checklist in the PR under review and check off each item as verified.
Pulumi has appropriate contact information from the provider maintainer
If the provider is community maintained (maintained by a person, not a company), then a GitHub handle is sufficient
If the provider is maintained by a company, Pulumi needs a contact person at the maintaining company.
The package will generate accurate documentation:
$ make bin/resourcedocsgen $ ./bin/resourcedocsgen metadata from-github \ --repoSlug '<repoSlug>' \ --schemaFile '<schemaFile>' \ --version '<version>'Here
<repoSlug>and<schemaFile>should match exactly the values added to/community-packages/package-list.json.This will generate metadata for the provider locally.
After pushing the provider to CI and waiting for a preview site:
Confirm that that CI passes for the PR with the metadata files.
Click through the site preview and confirm that the docs (for the new provider) render as expected.
The registry renders a valid logo for the new provider.
Hand-written docs are complete and accurate:
/docs/installation-configuration.md.Maintainers should run the
pulumi plugin install resource <name> <version> --server <pluginDownloadURL>command specified in the/docs/installation-configuration.mdand see a provider be downloaded./docs/installation-configuration.mdcontains a link to the published SDK in each language (i.e. TypeScript, Python, Go and C#)./docs/_index.mdcontains a minimal example in every supported language./docs/_index.mdcontains a brief explanation of what the package does.There is a published version:
vthat corresponds with a valid GitHub releaseA CODEOWNER has approved the PR.