Registry

Pulumi Registry is the public index of Pulumi extensions and integrations.

Adding a Package

To add a community package, open a pull request that adds a single entry to community-packages/package-list.json (steps below). This is the path for a provider published as a Pulumi Package with a committed schema.json: Native, Component, or a statically bridged Terraform provider (one you have built into your own provider repo). Automated checks then post a fact-sheet on your PR and a Pulumi maintainer approves it; you do not need to file an issue first.

A dynamically bridged Terraform provider is different: if you consume it with pulumi package add terraform-provider <name> and there is no provider repo or committed schema, it cannot be added by pull request, because those are listed through a separate Pulumi pipeline. Open a "New Package" issue to request one. Use the same issue to request a package you don't maintain, or to discuss before opening a PR.

For assistance, please reach out on the Pulumi community slack or get in touch with us via this contact form.

Adding a Pulumi Package that you have authored

We’re always eager to expand that index with new Pulumi Packages. To get started, use our guide on authoring a Pulumi Package of your own.

To publish a community-maintained package on the Pulumi Registry as a community member:

1. Ensure your provider repo has the following files:
   • docs/_index.md, which should contain a summary of the provider's purpose (required) along with a code sample in each language (required). This file will render as the index page for your provider (example).
   • docs/installation-configuration.md, which should contain links to published SDKs in (Go, Typescript, C#, Python; required) along with instructions for configuring the provider (e.g., required credentials and/or environment variables). This file will render as the Installation & Configuration page for your provider (example).
2. Create a release of your provider in GitHub with a "v" + Semver 2.0 compliant tag (vX.Y.Z).
3. Open a pull request that adds one entry to community-packages/package-list.json, and nothing else. Automated checks post a fact-sheet on your PR; if anything is flagged, fix it in your provider repo and comment /check to re-run. A Pulumi maintainer then approves. After merge your docs are generated and published for you, so you do not commit generated files in this PR.

Internal Process

Pulumi maintainers should follow the adding a new package guide.

About this repository

This repository is a Hugo module that doubles as a development server to make it easier to work on the pages that make up Pulumi Registry. It contains all of the Hugo content and layouts files, JavaScript, CSS, and web components. comprising what you see at https://pulumi.com/registry

We build the JavaScript and CSS bundles that power the Pulumi Registry here, under the themes/default/theme directory. If you are making styling changes along-side content changes, use make serve-all to enable hot reloading of both the pages and CSS/JS assets.

Using this repository

Prerequisites

We use Mise to manage the development environment. Install Mise then run:

mise trust && mise install

This should install all the dependencies you need to develop. Check out mise.toml to see what dependencies are used.

Installing dependencies

The prerequisites listed above need to be installed on your machine in order to serve the site.

1. Run make ensure to check for the appropriate tools and versions, and install any dependencies. The script will let you know if you're missing anything important.

make ensure

1. Once that succeeds, run make build_assets to build the assets the site depends on. This needs to be done before the first time you serve this repo so the assets exist on your local machine.

make build-assets

Running Hugo locally

Once you've run the above successfully, you're ready to run the development server:

make serve

Optionally, use make serve-all to enable hot reloading of both the pages and CSS/JS assets.

Generating API docs for packages

This repository does not contain the content of the API docs packages. We generate these pages at deployment time. In order to render the API docs for a package locally you will need to generate the API Docs pages for it. The API docs for packages can be generated on-demand using the resourcedocsgen tool.

To build the API docs for a single package, run:

make .make/content/registry/packages/<package_name>/api-docs

Run make bin/resourcedocsgen && ./bin/resourcedocsgen --help for help regarding its use or see the resourcedocsgen README.

Submitting, merging and releasing

Before submitting a pull request, run the linter locally:

make lint

When you're ready to submit a pull request, make sure you've removed anything that doesn't seem to belong (go.mod/go.sum changes, etc.) and submit the PR in the usual way.

Note

It currently requires a machine with a minimum of 32 GB of memory (64 GB preferred) to build the registry in its entirety including all pacakges.

Once your PR is approved and merged into the default branch of this repository, it will be deployed to the registry site (https://pulumi.com/registry).