Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Docs
  2. Pulumi Cloud
  3. Deployments
  4. Get Started Guides
  5. Use Pulumi Deployments with the New Project Wizard

Use Pulumi Deployments with the New Project Wizard

    This guide describes how to start using Pulumi Deployments with a new Pulumi IaC project created via the Pulumi Cloud New Project Wizard.

    Prerequisites

    Before you start, see the GitHub app installation instructions to configure your Pulumi organization to work seamlessly with Deployments.

    New Project Wizard

    It’s possible to create a new Pulumi project, commit its code, and deploy it entirely from within your browser by using Deployments in combination with the New Project Wizard.

    Navigate to the “New Project” tab. Select “Use a template” if you’d like to create a fully featured project, or select “Use a starter” if you want to create a bare-bones project with only the minimal necessary boilerplate.

    In order to use templates you will need to authorize Pulumi with GitHub so that it can clone private repositories as template sources and commit new code for your projects. Click the button and accept the required permissions if you would like to use templates.

    If you select “Use a template” and your Pulumi administrator has configured custom templates for your organization, you will be able to choose from your organization’s custom templates in a later step. If you select “Use a template” but your organization doesn’t have custom templates, you’ll be able to choose one of Pulumi’s public templates.

    On the next screen, select “Pulumi Deployments” as your deployment method.

    You may need to install the Pulumi GitHub app if you haven’t already.

    You’ll now be prompted to enter some information about the project you’re about to create.

    Project details

    Provide a name for the project you’re about to create, along with an optional description and a stack name to include.

    This impacts the resulting Pulumi.yaml file and the name of Pulumi.<stack>.yaml.

    Configuration

    This section allows you to provide values for any necessary configuration if you’re using a template that declares required configuration keys.

    This impacts the config stanza in Pulumi.<stack>.yaml.

    Environment

    If you’ve configured environments with your organization, you can specify one to use with the resulting stack.

    This enables the resulting stack to use a bundle of pre-configured secrets and configuration values without needing to re-specify all of them during project creation.

    Repository details

    Here you can configure the repository and optional subdirectory to use when committing your new project code.

    If you granted the Pulumi GitHub app access to all repositories, the New Project Wizard will allow users to create projects with Deployments enabled in new repositories.

    If the app only has access to some repositories, users will only be able to create new projects with Deployments enabled in existing repositories.

    The GitHub owner is not configurable, as that must match the Pulumi GitHub app’s owner in order to work with Deployments.

    Deployment settings

    After you’ve configured your project settings, you will be able to configure the behavior of Deployments, including when to trigger new Deployments and environment variables to include with your updates.

    A full description of each setting is available in Using Pulumi Deployments.

    After you’ve configured everything, you should see a new Deployment of your project.

    In summary, after going through this wizard you will have:

    • A new Pulumi project and stack, created from a project template or starter.
    • Code committed and pushed into a new or existing GitHub repository.
    • Pulumi Deployments configured on your new stack, and a preview Deployment in progress.
      PulumiUP May 6, 2025. Register Now.