Skip to content

Commit

Permalink
0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gpoitch committed May 24, 2018
1 parent 1853dca commit 466bb32
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

![sammie](https://user-images.githubusercontent.com/411908/35882654-ea43468a-0b52-11e8-9a0c-d5d721e56a51.gif)

---

### Prerequisites

[AWS CLI](https://aws.amazon.com/cli/) - sammie uses this for all AWS operations under the hood.
Expand All @@ -24,34 +26,39 @@ sammie deploy

This will generate a basic serverless application, deploy it to a development environment, and direct you to your app served over https!

---

### Commands

#### init - Generates a serverless application including a SAM template & lambda function

`sammie init <name>`
`sammie init <name>`
_Options:_
`-y, --yaml`: Generate yaml for SAM template. Defaults to json, because javascript.

#### deploy - Deploys application

`sammie deploy`
`sammie deploy`
_Options:_
`-t, --template`: Path to a SAM template. Defaults to `sam.(json|yaml)` in the current directory.
`-e, --environment`: An environment name to deploy. Defaults to "development".
`-p, --parameters`: A list of parameters to override in your template.

---

### Environments

It's a best practice to create completely separate stacks for each of your application's environments, rather than a single stack with multiple lambda qualifiers, API Gateway stages, and permissions. This makes your application more portable and reduces the blast radius of taking down your live application during the development cycle.

To support this, sammie will deploy separate stacks for you based on your environment option.
E.g. your stack name is "my-app":
`sammie deploy` will deploy stack "my-app-development"
To support this, sammie will deploy separate stacks for you based on the environment option:

E.g. your stack name is "my-app":
`sammie deploy` will deploy stack "my-app-development" (development is the default)
`sammie deploy --environment production` will deploy stack "my-app-production"

#### Environment variables & properties

To add environemnt specific variables & properties, you can create separate sam templates named with the environemnt suffix.
To add environemnt specific variables & properties, create separate sam templates named with the environemnt suffix.
E.g. `sam-production.json` containing the following, will get merged with your base template `sam.json` upon `sammie deploy --environment production`

```json
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sammie",
"version": "0.5.0",
"version": "0.6.0",
"description": "Serverless Application Model Made Infinitely Easier",
"license": "MIT",
"author": "Garth Poitras <garth22@gmail.com>",
Expand Down

0 comments on commit 466bb32

Please sign in to comment.