Skip to content

caffco/s3-glob-sync-github-action

Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Maintainability Test Coverage

S3 Glob Sync

Sync globs with AWS S3.

About

This action works with any S3-compatible service like Digital Ocean Spaces or AWS S3 and allows you to sync globs with it.

How it works

This action has 2 modes: upload and download.

In upload mode you should provide a list of patterns and a prefix and all the files matching the patterns will be uploaded to the S3 bucket, with the proper prefix.

In download mode you should provide a prefix and a destination folder. All the objects prefixed with that prefix will be downloaded to the desired destination folder.

Note that this action will not delete your objects or files in any case.

Usage

name: Test
on: [pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run tests
        run: yarn test
      - name: Upload artifacts
        uses: caffco/s3-glob-sync-github-action@v1.0.0
        with:
          prefix: my-prefix
          bucket_name: mybucket
          endpoint: mybucket.s3-us-west-2.amazonaws.com
          region: us-west-2
          access_key_id: ${{ secrets.S3_ACCESS_KEY_ID }}
          secret_access_key: ${{ secrets.S3_SECRET_ACCESS_KEY }}
          mode: upload
          acl: private
          patterns: |
            coverage/**
            reports/**
name: Consume tests
on:
  push:
    branches:
      - main
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Download artifacts
        uses: caffco/s3-glob-sync-github-action@v1.0.0
        with:
          prefix: my-prefix
          bucket_name: mybucket
          endpoint: mybucket.s3-us-west-2.amazonaws.com
          region: us-west-2
          access_key_id: ${{ secrets.S3_ACCESS_KEY_ID }}
          secret_access_key: ${{ secrets.S3_SECRET_ACCESS_KEY }}
          mode: download
          destination_folder: pr-artifacts
      - name: Do something with artifacts
        run: # Do something…

About

Sync globs to AWS S3

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages