Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (42 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 3.33 KB
Raw

Contributing to the Pulumi ecosystem

Do you want to contribute to Pulumi? Awesome! We are so happy to have you. We have a few tips and housekeeping items to help you get up and running.

Code of Conduct

Please make sure to read and observe our Code of Conduct

Community Expectations

Please read about our contribution guidelines here.

Setting up your development environment

Pulumi prerequisites

Please refer to the main Pulumi repo's CONTRIBUTING.md file for details on how to get set up with Pulumi.

You can quickly launch a shell environment with all the required dependencies using devbox:

# Install devbox if needed
$ which devbox || curl -fsSL https://get.jetpack.io/devbox | bash
$ devbox shell

Alternatively, you can develop in a preconfigured container environment using an editor or service that supports the devcontainer standard such as VS Code or GitHub Codespaces. Please note that building this project can be fairly memory intensive, if you are having trouble building in a container, please ensure you have at least 12GB of memory available for the container.

Committing Generated Code

You must generate and check in SDK updates on pull requests that change schema generation or provider API shape (for example changes under provider/pkg/schemagen/).

  1. Run make generate from the root of this repository
  2. Open a pull request containing all changes
  3. Note: If a large number of seemingly-unrelated diffs are produced by make generate (for example, lots of changes to comments unrelated to the change you are making), ensure that the latest dependencies for the provider are installed by running go mod tidy in the provider/ directory of this repository.

Running Integration Tests

The examples and integration tests in this repository will create and destroy real AWS cloud resources while running. Before running these tests, make sure that you have configured Pulumi with AWS successfully once before.

The only additional step you need to take to run tests in this repo is to set the AWS_REGION environment variable to the region you'd like to create test resources in. The integration tests do try to clean up after themselves by deleting everything that was created, but in the event of bugs or test failures you may need to go into the AWS Console and delete resources yourself.

Once you have set AWS_REGION and configured your AWS credentials, make test will run your integration tests.

AI-Assisted Contributions

  1. Read AGENTS.md before editing files.
  2. Prefer make test_provider for fast, local validation.
  3. If schema-generation inputs changed (for example provider/pkg/schemagen/**), run make generate and commit generated diffs.
  4. Use make test only for integration-level behavior changes or when explicitly requested, since it creates real AWS resources.
  5. Include command evidence in PRs (commands run and pass/fail outcomes).