# serverless-cloudformation-changesets-v3

> A serverless plugin for creating CloudFormation ChangeSets, modified for Serverless v3

Latest version **0.1.0** (published 2023-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install serverless-cloudformation-changesets-v3
pnpm add serverless-cloudformation-changesets-v3
yarn add serverless-cloudformation-changesets-v3
bun add serverless-cloudformation-changesets-v3
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-01-05 |
| First published | 2023-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0 |
| Dependencies | 0 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | AJ Stuyvenberg |
| Maintainers | aj.stuyvenberg |
| Keywords | serverless, serverless plugin, serverless cloudformation changeset, cloudformation changeset, aws |

## Links

- npm: https://www.npmjs.com/package/serverless-cloudformation-changesets-v3
- Repository: https://github.com/astuyve/serverless-cloudformation-changesets-v3
- Issues: https://github.com/astuyve/serverless-cloudformation-changesets-v3/issues
- npm.io page: https://npm.io/package/serverless-cloudformation-changesets-v3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2023-01-05

## README

# serverless-cloudformation-changesets-v3
[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)


Serverless framework plugin to create CloudFormation ChangeSets. Originally [forked](https://github.com/trek10inc/serverless-cloudformation-changesets) with the following modifications:
- Supports Serverless v3 new params
- Removed Serverless@1.89 dependency and specified peer dependency on Serverless ^3.0
- Removed dependency on Lodash

## Installation

Install the plugin from npm

```bash
$ npm install --save serverless-cloudformation-changesets-v3
```

Add the plugin to your `serverless.yml` file:

```yaml
plugins:
  - serverless-cloudformation-changesets-v3
```

## Usage
#### CLI options
Add `--changeset` option to the sls deployment command, e.g.:
```bash
$ sls deploy --stage dev --region us-east-1 --param="changeset"
```
`changeset` by default uses a timestamp for ChangeSet name, otherwise you can provide optional `changeset` value:
```bash
$ sls deploy --stage dev --region us-east-1 --param='changeset=your-changeset-name'
```

#### YAML settings
```yaml
custom:
  cf-changesets:
    changeSetName: whatever # optional
    requireChangeSet: boolean # optional defaults to false
```
`requireChangeSet` - if true, ChangeSets will be created without providing `changeset` option to the `sls deploy` command.

## Notice
If CloudFormation Stack doesn't exist and custom `provider.deploymentBucket` was specified, this plugin will create a new stack without template, resources. The stack will be in the `REVIEW_IN_PROGRESS` state.

---
_Source: https://npm.io/package/serverless-cloudformation-changesets-v3 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._