@atomisthq/pulumi

Library of Pulumi IAC TypeScript helper functions and types

Usage no npm install needed!

<script type="module">
  import atomisthqPulumi from 'https://cdn.skypack.dev/@atomisthq/pulumi';
</script>

README

@atomisthq/pulumi

Library of Pulumi infrastructure-as-code (IAC) TypeScript helper functions and types.

Using

You can add the dependency to your package as you usually would.

$ npm install @atomisthq/pulumi

If you want to provide the update-ip script to the users of your IAC repo, add this to your package.json scripts:

{
  …
  "scripts": {
    …
    "ip": "update-ip",
    …
  },
  …
}

and instruct them to run npm run ip to add/update their IP address in the stack's configuration. Typically you would then commit and push the change so the Pulumi skill will effect the change on the cluster.

Contributing

Contributions to this project from community members are encouraged and appreciated. Please review the Contributing Guidelines for more information. Also see the Development section in this document.

Code of conduct

This project is governed by the Code of Conduct. You are expected to act in accordance with this code by participating. Please report any unacceptable behavior to code-of-conduct@atomist.com.

Connect

Follow @atomist on Twitter and The Atomist Blog.

Support

General support questions should be discussed in the #help channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Development

Install dependencies.

$ npm ci

Make your changes, run the build.

$ npm run build

Commit your changes and push.

Release

Push a release semantic version tag.

$ t=v$(jq -r .version package.json) && git tag -s -m "$t: Some release" "$t" && git push origin "$t"

You can create a prerelease by pushing a prerelease semantic version tag.


Created by Atomist. Need Help? Join our Slack workspace.