Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.74 KB

Contributing to Pulumi

Do you want to hack on Pulumi? Awesome! We are so happy to have you.

Please refer to the main Pulumi repo's CONTRIBUTING.md file for details on how to do so.

Committing Generated Code

Code generated for Pulumi SDKs should be checked in as part of the pull request containing a particular change. To generate code after making changes, run make from the root of this repository.

If a large number of seemingly-unrelated diffs are produced by make (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 make ensure in the root of the repository.

Running Integration Tests

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

You need to set these environment variables before running the integration tests:

  1. GOOGLE_PROJECT - The name of the project to deploy test resources into.
  2. GOOGLE_REGION - The name of the region to deploy test resources into.
  3. GOOGLE_ZONE - The name of the zone within the chosen region to deploy test resources into.

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 Google Cloud portal and delete resources yourself.

Once you have set all required environment variables and configured your GCP credentials, make test_all will run all integration tests.