Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanlawson authored May 23, 2024
1 parent 15b5dad commit f3ac03f
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@

This Action wraps the [Serverless Framework](https://serverless.com) to enable common Serverless commands.

## This project is looking for maintainers!

If you would like to be a maintainer of this project, please reach out to one of the active [Serverless organization](https://github.com/serverless) members to express your interest.

Welcome, and thanks in advance for your help!

## Usage

An example workflow to deploy a project with serverless v3:
An example workflow to deploy a project with the Serverless Framework:


```yaml
Expand Down Expand Up @@ -61,15 +55,15 @@ jobs:
### Minimal example
```yaml
- name: Deploy
uses: serverless/github-action@v4.0
uses: ryanlawson/serverless-github-action@v1.0
with:
args: deploy
```
### Use local credentials
```yaml
- name: Deploy with local credentials
uses: serverless/github-action@v4.0
uses: ryanlawson/serverless-github-action@v1.0
with:
aws-credentials: true # or yes
args: deploy
Expand All @@ -81,7 +75,7 @@ jobs:
### Install packages and deploy
```yaml
- name: Install packages and deploy
uses: serverless/github-action@v4.0
uses: ryanlawson/serverless-github-action@v1.0
with:
install-packages: serverless-offline serverless-prune-plugin
args: deploy
Expand All @@ -90,7 +84,7 @@ jobs:
### Use a particular Serverless Framework CLI version
```yaml
- name: Deploy using a particular version of serverless
uses: serverless/github-action@v4.0
uses: ryanlawson/serverless-github-action@v1.0
with:
serverless-version: 2
args: deploy
Expand All @@ -99,18 +93,12 @@ jobs:
### Change your working directory
```yaml
- name: Deploy from a particular working directory
uses: serverless/github-action@v4.0
uses: ryanlawson/serverless-github-action@v1.0
with:
working-directory: ./foo
args: deploy
```
## Use a previous version
Change the action with `@{version}`, for example:
```yaml
uses: serverless/[email protected]
```

## License
The Dockerfile and associated scripts and documentation in this project are released under the Apache-2 license.

0 comments on commit f3ac03f

Please sign in to comment.