README.md

s3-upload-action

This action upload a file to AWS S3

Usage

workflow.yml Example

Place in a .yml file such as this one in your .github/workflows folder. Refer to the documentation on workflow YAML syntax here.

name: Upload to S3

on: [pull_request]

jobs:
  upload:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: sellpy/s3-upload-action@main
        with:
          aws_secret_access_key_id: ${{ secrets.AWS_SECRET_ACCESS_KEY_ID }}
          aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
          aws_bucket: my_bucket
          source_file_path: 'path/to/file.json'
          destination_file_path: 'destination/file.json'

Action inputs

The following settings must be passed as environment variables as shown in the example. Sensitive information, especially aws_secret_access_key_id and aws_secret_access_key, should be set as encrypted secrets — otherwise, they'll be public to anyone browsing your repository's source code

Name	Required	Default value	Description
aws_secret_access_key_id	✔️	-	Your AWS Secret Access Access Key Id.
aws_secret_access_key	✔️	-	Your AWS Secret Access Key.
aws_bucket	✔️	-	The name of the bucket you're upload to.
source_file_path	✔️	-	The local file you wish to upload to S3.
destination_file_path	✔️	-	The destination path in S3
aws_region	-	eu-west-1	The AWS region of the bucket.
acl	-	private	The Access Control List of the uploaded object.