Community Package List Format
File Location#
community-packages/package-list.json
Structure#
The file is a JSON object with an include array:
{
"include": [
{
"repoSlug": "{owner}/{repo}",
"schemaFile": "{path-to-schema-file}"
}
]
}Entry Format#
Each entry has two required fields:
| Field | Description | Example |
|---|---|---|
repoSlug |
GitHub {owner}/{repo} format (without https://github.com/) |
pulumiverse/pulumi-example |
schemaFile |
Path to the schema JSON file within the repository | provider/cmd/pulumi-resource-example/schema.json |
Example Entry#
{
"repoSlug": "koyeb/pulumi-koyeb",
"schemaFile": "provider/cmd/pulumi-resource-koyeb/schema.json"
}Insertion Rules#
- Add the new entry to the
includearray - Maintain alphabetical order by
repoSlug - Ensure valid JSON (proper comma placement)
- No duplicate
repoSlugentries
Validation#
After adding an entry, verify:
python3 -m json.tool community-packages/package-list.json > /dev/null