Package YAML Template

Template#

# WARNING: this file was generated by resourcedocsgen
# Do not edit by hand unless you're certain you know what you are doing!
category: {category}
component: {component}
description: "{description}"
featured: false
logo_url: ""
name: {name}
package_status: ga
publisher: {publisher}
repo_url: {repo_url}
schema_file_url: {schema_file_url}
title: {title}
updated_on: {unix_timestamp}
version: {version}

Field Descriptions#

Field	Description	Example
`category`	Provider category (see valid values below)	`Cloud`
`component`	Whether this is a component provider	`false`
`description`	Brief description of the provider	`"A Pulumi package for managing Example resources"`
`featured`	Whether to feature on registry homepage (set to `false` for new packages)	`false`
`logo_url`	URL to provider logo (leave empty if none)	`""`
`name`	Package short name (lowercase, alphanumeric + hyphens)	`example-provider`
`package_status`	Release status	`ga`
`publisher`	Organization or individual publishing the provider	`pulumiverse`
`repo_url`	GitHub repository URL	`https://github.com/pulumiverse/pulumi-example`
`schema_file_url`	URL to the provider's schema JSON file	`https://raw.githubusercontent.com/...`
`title`	Human-readable display name	`Example Provider`
`updated_on`	Unix timestamp of last update	`1710000000`
`version`	Semver version with `v` prefix	`v1.0.0`

Valid Categories#

Cloud
Database
Infrastructure
Monitoring
Network
Utility
Version Control System

Schema File URL Construction#

For GitHub-hosted schemas, construct the raw URL:

https://raw.githubusercontent.com/{owner}/{repo}/{default-branch}/{schema-file-path}

Common schema file paths:

provider/cmd/pulumi-resource-{name}/schema.json
schema.json
provider/schema.json

Notes#

updated_on should be set to the current Unix timestamp: date +%s
version should match the latest release tag from the repository
featured: false for all new packages (featuring is a manual editorial decision)
logo_url can be left empty — it will be populated later if a logo is available