Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-turo/actions-s3-artifact

GitHub Action: manage S3 artifacts in workflows
https://github.com/open-turo/actions-s3-artifact

action actions artifacts gha github s3 tool tooling tools

Last synced: about 12 hours ago
JSON representation

GitHub Action: manage S3 artifacts in workflows

Host: GitHub
URL: https://github.com/open-turo/actions-s3-artifact
Owner: open-turo
License: mit
Created: 2022-09-21T22:50:57.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-07-18T19:56:07.000Z (4 months ago)
Last Synced: 2024-07-19T03:46:55.380Z (4 months ago)
Topics: action, actions, artifacts, gha, github, s3, tool, tooling, tools
Language: Shell
Homepage:
Size: 33.2 KB
Stars: 1
Watchers: 7
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # `open-turo/actions-s3-artifact`

GitHub Action: manage S3 artifacts in workflows

[![Release](https://img.shields.io/github/v/release/open-turo/actions-s3-artifact)](https://github.com/open-turo/actions-s3-artifact/releases/)

[![Tests pass/fail](https://img.shields.io/github/workflow/status/open-turo/actions-s3-artifact/CI)](https://github.com/open-turo/actions-s3-artifact/actions/)

[![License](https://img.shields.io/github/license/open-turo/actions-s3-artifact)](./LICENSE)

[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/dwyl/esta/issues)

![CI](https://github.com/open-turo/actions-s3-artifact/actions/workflows/release.yaml/badge.svg)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![Conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.2-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

[![Join us!](https://img.shields.io/badge/Turo-Join%20us%21-593CFB.svg)](https://turo.com/jobs)

## Actions

### action: [`upload`](./upload)

Upload will tarball and upload artifact(s) to S3 and optionally manage

authentification if AWS credentials are specified.

See usage [here](./upload/README.md#usage).

Documentation is found [here](./upload/README.md).

### action: [`download`](./download)

Download will download artifacts from s3 path and optionally extract files from

tar if s3 path ends with `.tgz` or `.tar.gz`.

See usage [here](./download/README.md#usage).

Documentation is found [here](./download/README.md).

## Get Help

Each Action has a detailed README for how to use it as referenced above. Please review Issues, post new Issues against this repository as needed.

## Contributions

Please see [here](https://github.com/open-turo/contributions) for guidelines on how to contribute to this project.

## Use cases

- actions-s3-artifact/upload

  - Upload a build artifact to S3 for future use externally

    - Uploading an ML model to use in a container

    - Uploading a Javascript bundle for serving

  - Upload an artifact for future use in another job

    - Uploading a preprocessed data set for use in a training job

    - Uploading a javascript build for use in parallel jobs

- actions-s3-artifact/download

  - Needs to be able to fail without erroring the pipeline for a cache-like behavior

  - Needs to be able to output its success status for future pipeline steps

  - Download an external artifact from S3 for use in a job

    - Downloading data set to work with in CI/CD

    - Downloading ML model to build into deployment CD

  - Download an artifact from a previous job for use in a job

    - Downloading a preprocessed data set for use in a training job

    - Downloading a javascript build for use in parallel jobs

- actions-s3-artifact

  - TBD: Might not be worth it

  - Cache and retrieve an artifact based on a possibly changing key or hash of a file

  - Check cache

  - If it's present, skip computation

  - If it's not present, compute

  - Upload to cache, if it was not retrieved