First-Party Provider Setup Checklist
How It Works#
- The provider repository sends a
resource-providerdispatch event topulumi/registry - The
publish-provider-update.ymlworkflow inpulumi/registryhandles the event - The workflow updates the package YAML and publishes to the live registry
Checklist for Provider Repository#
The following must be configured in the provider repository (not in pulumi/registry):
- Repository dispatch: Configure CI/CD to send
repository_dispatchevents with typeresource-providertopulumi/registryon new releases - Event payload: Include
provider_nameandversionin the dispatch payload - GitHub token: Ensure the CI/CD pipeline has a token with
reposcope forpulumi/registry(typically via a shared bot token or GitHub App) - Schema file: Ensure the schema JSON file is published and accessible at the URL specified in the package YAML
Example Dispatch Event#
{
"event_type": "resource-provider",
"client_payload": {
"provider_name": "example",
"version": "v1.0.0"
}
}What to Tell the User#
Display this message after creating the package YAML:
First-party provider packages are updated automatically via repository_dispatch.
The provider repo ({repo_url}) needs to be configured to send
'resource-provider' dispatch events to pulumi/registry when new
versions are released. This triggers the publish-provider-update.yml
workflow which updates the package metadata and publishes to the
live registry.
Please coordinate with the provider team to set up the dispatch
event in their CI/CD pipeline.