Skip to content

Commit

Permalink
My first action is ready
Browse files Browse the repository at this point in the history
  • Loading branch information
quenginedev committed Sep 4, 2022
1 parent 51afca7 commit c625cb4
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# SST Deploy JS action

This action deploys your serverless stack application

## Inputs

### `access-key-id`
**Required** AWS ACCESS_KEY_ID.

### `secret-access-key`
**Required** AWS SECRET_ACCESS_KEY

### `region`
**Optional** AWS Region - [ us-east-1 ]

### `stage`
**Optional** Staging environment - [ production ]

### `pkg-manger`
**Optional** Package mangers for your lock file. options are npm, yarn - [ yarn ]


## Outputs
```
Using stage: production
Preparing your SST app
Deploying stacks
✅ production-sst-deploy-demo-MyStack (no changes)
Stack production-sst-deploy-demo-MyStack
Status: no changes
Outputs:
ApiEndpoint: https://xxxxxxxxx.execute-api.us-east-1.amazonaws.com
```


## Example usage

```
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
name: A job to SST to prod
steps:
- name: Checkout
uses: actions/checkout@v2
with:
path: "./"
- name: Install Dependencies
uses: actions/setup-node@v3
with:
node-version: 16
- name: Deploy SST app
id: deploy
uses: quenginedev/sst-deploy@main
with:
access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
region: ${{ secrets.AWS_DEFAULT_REGION }}
path: './'
```

0 comments on commit c625cb4

Please sign in to comment.