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

feat: add Pulumi Fly #6854

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add Pulumi Fly #6854

wants to merge 1 commit into from

Conversation

dirien
Copy link
Contributor

@dirien dirien commented Mar 10, 2025

After several demands from the commuity to add this to the registry.

After several demands from the commuity to add this to the registry.
@dirien dirien requested a review from a team as a code owner March 10, 2025 12:00
@dirien
Copy link
Contributor Author

dirien commented Mar 10, 2025

Closes dirien/pulumi-fly#309

Copy link

Your site preview for commit 8cc0ef1 is ready! 🎉

http://registry--origin-pr-6854-8cc0ef19.s3-website.us-west-2.amazonaws.com/registry.

@iwahbe iwahbe self-assigned this Mar 10, 2025
@iwahbe
Copy link
Member

iwahbe commented Mar 10, 2025

The publishing checklist:

  • 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:

    1. Check out the PR under review and run:
    $ 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.

    1. Push the metadata files into a PR (either back to the PR under review or a new PR).

    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:

    • Validate that you can install the new provider with the instructions found in /docs/installation-configuration.md.

    Maintainers should run the pulumi plugin install resource <name> <version> --server <pluginDownloadURL> command specified in the /docs/installation-configuration.md and see a provider be downloaded.

    • /docs/installation-configuration.md contains a link to the published SDK in each language (i.e. TypeScript, Python, Go and C#).

    • /docs/_index.md contains a minimal example in every supported language.

    • /docs/_index.md contains a brief explanation of what the package does.

  • There is a published version:

    • The repository has a version tag prefixed with v that corresponds with a valid GitHub release
    • Each published SDK has a matching release
  • A CODEOWNER has approved the PR.

@iwahbe iwahbe mentioned this pull request Mar 10, 2025
@iwahbe
Copy link
Member

iwahbe commented Mar 10, 2025

@dirien thanks for opening a publish PR. You can see a preview of the registry page for your provider here. To publish, can you please:

  • Fix the TODOs in your _index.md page (code, rendered). It would be great to add a YAML example, but it's not necessary.
  • Fix the Go installation link so it leads to a valid location (code, rendered)
  • Add a valid logo_url in the schema.

After you make these changes, please publish a new version of dirien/pulumi-fly.

@iwahbe iwahbe added the awaiting-feedback Blocked on input from the author label Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-feedback Blocked on input from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants