pulumi-best-practices

Review Pulumi TypeScript and Python programs for resource management and security best practices.

1|Updated Apr 14, 2025
One-click install
npx skills add https://github.com/mattwyskiel/dotfiles --skill pulumi-best-practices-mattwyskiel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pulumi-best-practices
Source: https://github.com/mattwyskiel/dotfiles/tree/main/agents/.agents/skills/pulumi-best-practices
Command: npx skills add https://github.com/mattwyskiel/dotfiles --skill pulumi-best-practices-mattwyskiel

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures Pulumi TypeScript/Python programs adhere to best practices, improving code quality, maintainability, and reliability.

Core Features & Use Cases

  • Code Review and Refactoring: Analyze code for adherence to best practices in Pulumi programming.
  • Dependency Management: Ensures correct resource dependencies and output usage.
  • Component Resource Guidance: Provides guidance on creating reusable and maintainable ComponentResource classes.
  • Secrets Management: Ensures secrets are encrypted and managed securely.
  • Refactoring Support: Helps in renaming resources and refactoring without data loss.
  • Deployment Validation: Offers a pre-deployment preview step to validate changes.

Quick Start

Use the pulumi-best-practices skill to validate the best practices in your Pulumi codebase.

Frequently Asked Questions about pulumi-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I ensure correct resource dependencies and output usage in Pulumi programs?

You can ensure correct resource dependencies and output usage in Pulumi programs by applying best practices for dependency management, which helps correctly sequence resource creation and handle outputs to maintain code reliability.

What is the best way to manage secrets securely in Pulumi TypeScript and Python projects?

The best way to manage secrets in Pulumi projects is to ensure they are encrypted and managed securely using established best practices, preventing accidental exposure of sensitive data in your infrastructure code.

How do I refactor Pulumi resources without causing data loss?

To refactor Pulumi resources without data loss, you should follow specific refactoring guidance that helps you safely rename resources and restructure code while preserving the state of existing infrastructure components.

Can I use Pulumi best practices for creating reusable ComponentResource classes?

Yes, you can use Pulumi best practices for creating reusable ComponentResource classes, which provides guidance on structuring these components to improve the maintainability and modularity of your infrastructure code.

Does Pulumi best practices validation work for both TypeScript and Python programs?

Yes, Pulumi best practices validation works for both TypeScript and Python programs, analyzing your codebase to ensure adherence to resource management, output usage, and security standards across both languages.

When do I need a pre-deployment preview step for Pulumi infrastructure changes?

You need a pre-deployment preview step for Pulumi changes to validate modifications before applying them, ensuring that your infrastructure updates align with best practices and preventing unexpected deployment failures.