Skip to content

Commit 393abd5

Browse files
committed
Update README
1 parent f3ac03f commit 393abd5

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ This Action wraps the [Serverless Framework](https://serverless.com) to enable c
66

77
An example workflow to deploy a project with the Serverless Framework:
88

9-
109
```yaml
1110
name: Deploy master branch
1211

@@ -30,7 +29,7 @@ jobs:
3029
node-version: ${{ matrix.node-version }}
3130
- run: npm ci
3231
- name: serverless deploy
33-
uses: serverless/github-action@v3.2
32+
uses: ryanlawson/serverless-github-action@v1.0
3433
with:
3534
args: deploy
3635
env:
@@ -53,6 +52,7 @@ jobs:
5352
## Examples
5453

5554
### Minimal example
55+
Basic deployment with no customization
5656
```yaml
5757
- name: Deploy
5858
uses: ryanlawson/serverless-github-action@v1.0
@@ -61,6 +61,7 @@ jobs:
6161
```
6262
6363
### Use local credentials
64+
Ensures `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are present and uses them to authenticate
6465
```yaml
6566
- name: Deploy with local credentials
6667
uses: ryanlawson/serverless-github-action@v1.0
@@ -73,6 +74,7 @@ jobs:
7374
```
7475

7576
### Install packages and deploy
77+
Installs any additional packages (usually [Serverless plugins](https://www.serverless.com/plugins)) prior to deploying
7678
```yaml
7779
- name: Install packages and deploy
7880
uses: ryanlawson/serverless-github-action@v1.0
@@ -82,6 +84,7 @@ jobs:
8284
```
8385

8486
### Use a particular Serverless Framework CLI version
87+
Installs a specific version of the Serverless Framework
8588
```yaml
8689
- name: Deploy using a particular version of serverless
8790
uses: ryanlawson/serverless-github-action@v1.0
@@ -91,6 +94,7 @@ jobs:
9194
```
9295

9396
### Change your working directory
97+
Sets a specific working directory (usually the root of the repository) for your Serverless configuration
9498
```yaml
9599
- name: Deploy from a particular working directory
96100
uses: ryanlawson/serverless-github-action@v1.0

0 commit comments

Comments
 (0)