S3 Zip Upload Action

A GitHub Action for easily creating a zip file from a folder and uploading it to S3.
This action can also be used to upload a pre-made zip file or any other single file.
It supports Linux, Windows, and any other runs-on that can run Node.

Features

Creates zip files and uploads them to S3
Can upload pre-made zip files or any other single files
Supports Linux, Windows, and other runs-on that can run Node
Easy to configure and use

Inputs

All inputs are environment variables. See the example below for usage.

AWS_SECRET_ID: AWS access key ID (required)
AWS_SECRET_KEY: AWS secret access key (required)
BUCKET_NAME: AWS bucket name (required) STORAGE_CLASS: AWS storage class (defaults to STANDARD) AWS_REGION: AWS region (defaults to eu-central-1)
SOURCE_MODE: Source mode (defaults to ZIP) - ZIP: Assumes SOURCE_PATH is a directory. Creates a zip file from the source path and uploads it to S3 (default) - FILE: Assumes SOURCE_PATH is a premade zip file. Uploads a single file to S3. SOURCE_PATH: This should be a file or a directory depending on your source mode. (required)
DEST_FILE: Output file name or path inside the bucket. (required)
S3_ENDPOINT: Optional override S3 endpoint for custom S3 implementations. Region is still required.

Example usage

name: Upload to S3
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Upload ZIP to S3
        uses: NotCoffee418/s3-zip-upload@v1.2
        env:
          AWS_SECRET_ID: ${{ secrets.AWS_SECRET_ID }}
          AWS_SECRET_KEY: ${{ secrets.AWS_SECRET_KEY }}
          BUCKET_NAME: ${{ secrets.BUCKET_NAME }}
          AWS_REGION: eu-central-1
          SOURCE_MODE: ZIP
          SOURCE_PATH: ./debug-override
          DEST_FILE: debug-action.zip

Manual action tests

Copy .env.example to .env and modify it. Commands to run locally:

npm run debug # run using your .env configuration
npm run debug file # uploads a dummy file as debug-override/dog1.jpg
npm run debug zip # uploads a dummy folder as debug-override/debug-action.zip

Releasing new version