Skip to content

Commit a7f7d6b

Browse files
committed
Renamed to gald
1 parent cb7b5fe commit a7f7d6b

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Usage
1+
# aws-lambda-deploy
2+
## Usage
3+
4+
```
5+
gald [command] [option]
6+
```
27

38
There are 3 commands available
49
```
5-
node-lambda init
6-
node-lambda test
7-
node-lambda deploy
10+
gald init
11+
gald test
12+
gald deploy
813
```
914
### Commands
1015

@@ -15,18 +20,37 @@ files that provide information
1520
to the module about
1621
the AWS Lambda function.
1722

23+
After running `init` you should consider
24+
adding `lambda-secrets.json`
25+
to your `.gitignore`.
26+
1827
#### test
1928

20-
Executa all defined tests in `lambda-test.json`
29+
Execute all defined tests in `lambda-test.json`
2130
or a different JSON file.
2231

2332
```
24-
node-lambda test [optional json file]
33+
gald test [optional json file]
2534
```
2635

2736
#### deploy
2837

2938
Deploys the Lambda function to AWS Lambda.
30-
In case the Lambda funciton does not exist
39+
In case the Lambda function does not exist
3140
or the configuration has been changed,
3241
the user will be notified.
42+
43+
Deploy looks for the archive defined in
44+
`lambda-config.json` under the property `archiveName`.
45+
Your build system will have to provide a zip file
46+
with the necessary components
47+
for the AWS Lambda function.
48+
49+
For example, have a build script that looks like this:
50+
```
51+
zip -r -9 archive.zip handler.js
52+
```
53+
If your AWS Lambda function depends on other packages,
54+
make sure to include the `node_modules` folder,
55+
with the dependencies installed,
56+
in your zip file.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "aws-node-lambda-helper",
2+
"name": "@gidw/aws-lambda-deploy",
33
"version": "1.0.0",
44
"description": "Helper module for deploying AWS Lambda functions in Node.js.",
55
"author": "Gilles De Waele",
66
"license": "MIT",
77
"main": "lib/main.js",
88
"bin": {
9-
"node-lambda": "./bin/cli.js"
9+
"gald": "./bin/cli.js"
1010
},
1111
"keywords": [
1212
"aws",

0 commit comments

Comments
 (0)