Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/islishude/spa-deploy-action
Deploy your single page applications to S3 with correct cache control
https://github.com/islishude/spa-deploy-action
actions aws deployment s3 single-page-applications spa
Last synced: 2 days ago
JSON representation
Deploy your single page applications to S3 with correct cache control
- Host: GitHub
- URL: https://github.com/islishude/spa-deploy-action
- Owner: islishude
- License: mit
- Created: 2023-09-02T14:05:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-01T04:22:10.000Z (28 days ago)
- Last Synced: 2025-01-01T04:26:24.821Z (28 days ago)
- Topics: actions, aws, deployment, s3, single-page-applications, spa
- Language: TypeScript
- Homepage:
- Size: 2.42 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spa-deploy-action
[](https://github.com/islishude/spa-deploy-action/actions/workflows/ci.yml)
Deploy your single page application to S3 with correct cache control
## Usage
```yaml
name: Build and deploy your spa
on:
push:
branches:
- main
permissions:
contents: read
id-token: write
jobs:
spa_build_deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: arn:aws:iam::111111111111:role/my-github-actions-role
aws-region: us-east-1
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
- name: Deploy
uses: islishude/spa-deploy-action@v1
with:
dir-path: 'dist'
s3-bucket: your-s3-bucket-name
```
## Inputs
| Name | Type | Default | Required | Description |
| -------------------------- | ------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| dir-path | string | | yes | directory path for deploying |
| s3-bucket | string | | yes | aws s3 bucket name |
| s3-bucket-prefix | string | | no | aws s3 bucket prefix to deploy |
| delete | bool | true | no | files that exist in the s3 but not in the local are deleted |
| cache-control | json | {} | no | file glob and cache control directive pairs, the glob matcher uses [minimatch](https://github.com/isaacs/minimatch) |
| cache-control-merge-policy | string | upsert | no | used for merge built-in and your custom cache-control |
| default-cache-control | string | | no | use if no matched with cache-control |
## Built-in cache control mapping
```json
{
"index.html": "public,max-age=60,stale-while-revalidate=2592000",
"*.css": "public,max-age=31536000,immutable",
"*.js": "public,max-age=31536000,immutable",
"*.png": "public,max-age=86400,stale-while-revalidate=2592000",
"*.jpg": "public,max-age=86400,stale-while-revalidate=2592000",
"*.ico": "public,max-age=86400,stale-while-revalidate=2592000",
"*.svg": "public,max-age=86400,stale-while-revalidate=2592000"
}
```
you can provide a cache-control input to update it.
if you use the default `cache-control-merge-policy: 'upsert'`, the action will
update an existing key if a specified value already exists in the built-in cache
control mapping, and insert a new key-value if the specified value doesn't
already exist
if you use `cache-control-merge-policy: 'replace'`, the action will use the
`cache-control` input you provided.
## Required AWS IAM Policy
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["s3:ListBucket"],
"Resource": "arn:aws:s3:::mybucket"
},
{
"Effect": "Allow",
"Action": ["s3:PutObject", "s3:DeleteObject"],
"Resource": "arn:aws:s3:::mybucket/prefix/*"
}
]
}
```