Giter Club home page Giter Club logo

templates's Introduction

Build Status

Pulumi Templates

This repo contains the templates for pulumi new, which make it easy to quickly get started building new Pulumi projects.

Adding a new template

  1. Create a new directory for the template, e.g. my-template-javascript. By convention, hyphens are used to separate words and the language is included as a suffix.

  2. Add template files in the new directory.

  3. If the template is an architecture template, include the requisite supplemental metadata at ./metadata:

    • If the template adds to an existing template group (for example, if it's a new a static-website-aws template), add a new line for the template in the templates section of that group:

        name: AWS Static Website
        ...
        templates:
          ...
          - static-website-go
          - static-website-csharp
      -   - static-website-yaml
      +   - static-website-yaml
      +   - static-website-java
    • If the template introduces a new architecture, make a new entry in ./metadata/architectures.yaml using the others as a guide (the keys and slug values correspond with these templates' eventual paths at https://pulumi.com/templates), then add a new file that lists the new template at ./metadata/groups/{architecture}-{cloud}-{language}.yaml. Set the new group's parent property to match the key/name of the item you added to architectures.yaml.

  4. Request a review from the @pulumi/content-engineering team.

Text replacement

The following special strings can be included in any template file; these will be replaced by the CLI when laying down the template files.

  • ${PROJECT} - The name of the project.
  • ${DESCRIPTION} - The description of the project.

templates's People

Contributors

aaronfriel avatar aaronkao avatar cnunciato avatar cstanger avatar cyrusnajmabadi avatar ellismg avatar evanboyle avatar frassle avatar indrora avatar iwahbe avatar jaxxstorm avatar joeduffy avatar justinvp avatar lblackstone avatar lindydonna avatar lukehoban avatar mikhailshilkov avatar mingfang avatar pawelprazak avatar pgavlin avatar praneetloke avatar pulumi-bot avatar scottslowe avatar sean1588 avatar simenandre avatar stack72 avatar swgillespie avatar t0yv0 avatar thomas11 avatar zaid-ajaj avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.