Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/clowdhaus/aws-github-actions

Deploy 🚀 to AWS ☁️ with :octocat: GitHub Actions!
https://github.com/clowdhaus/aws-github-actions

aws aws-cloudfront aws-lambda aws-s3 ci-cd github-actions serverless

Last synced: 12 days ago
JSON representation

Deploy 🚀 to AWS ☁️ with :octocat: GitHub Actions!

Host: GitHub
URL: https://github.com/clowdhaus/aws-github-actions
Owner: clowdhaus
License: apache-2.0
Created: 2019-12-30T17:47:34.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-09-12T14:10:17.000Z (about 2 months ago)
Last Synced: 2024-09-13T02:12:17.391Z (about 2 months ago)
Topics: aws, aws-cloudfront, aws-lambda, aws-s3, ci-cd, github-actions, serverless
Language: TypeScript
Homepage:
Size: 3.69 MB
Stars: 116
Watchers: 5
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: .github/README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-actions - GitHub Actions for AWS
fucking-awesome-actions - GitHub Actions for AWS
awesome-workflows - GitHub Actions for AWS

README

        


  





  aws-github-actions





  

  

  

  



Collection of GitHub actions for interacting with AWS services.

| Action                                                                                    | Local Action Tests                                                                                                      |

| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |

| [`clowdhaus/aws-github-actions/awscli@main`](../awscli)                                 | ![AWS Command Line Interface](https://github.com/clowdhaus/aws-github-actions/workflows/awscli/badge.svg)               |

| [`clowdhaus/aws-github-actions/cloudfront_invalidate@main`](../cloudfront_invalidate)   | ![CloudFront Invalidate](https://github.com/clowdhaus/aws-github-actions/workflows/CloudFront%20Invalidation/badge.svg) |

| [`clowdhaus/aws-github-actions/iam_access_credentials@main`](../iam_access_credentials) | ![IAM Access Credentials](https://github.com/clowdhaus/aws-github-actions/workflows/IAM%20Credentials/badge.svg)        |

| [`clowdhaus/aws-github-actions/s3_sync@main`](../s3_sync)                               | ![S3 Sync](https://github.com/clowdhaus/aws-github-actions/workflows/S3%20Sync/badge.svg)                               |

## Usage

See individual action directory for details on usage and examples.

- [AWS Command Line Interface](../awscli) - execute awscli commands

- [CloudFront Invalidate](../cloudfront_invalidate) - invalidate AWS CloudFront distribution to force cache refresh

- [IAM Access Credentials](../iam_access_credentials) - ensure GitHub actions workflow environment has necessary AWS IAM credentials available for subsequent AWS actions

- [S3 Sync](../s3_sync) - synchronize local files to remote AWS S3 bucket

## Getting Started

This project is setup as a monorepo using [lerna](https://github.com/lerna/lerna) and [yarn](https://github.com/yarnpkg/yarn) workspaces. If you are unfamiliar with these tools or the practice of a monorepo, I would suggest taking a look at the following articles (I am certain there are many more, but these seemed complete and worthy of a mention):

- [Create a Monorepo with Lerna & Yarn Workspaces](https://medium.com/hy-vee-engineering/creating-a-monorepo-with-lerna-yarn-workspaces-cf163908965d)

- [Why Lerna and Yarn Workspaces is a Perfect Match for Building Mono-Repos – A Close Look at Features and Performance](https://doppelmutzi.github.io/monorepo-lerna-yarn-workspaces/)

The following instructions will help you get setup for development and testing purposes.

### Prerequisites

#### [yarn](https://github.com/yarnpkg/yarn)

`yarn` is used to handle dependencies and executing scripts on the codebase.

See [here](https://yarnpkg.com/en/docs/install#debian-stable) for instructions on installing yarn on your local machine.

#### [lerna](https://github.com/lerna/lerna)

`lerna` is used to managed the project as a monorepo - where each action is packaged and managed individually, and some packages are internal modules shared across the actions.

To install locally on your machine, it is recommended to install globally via npm or yarn:

```bash

$ npm install lerna --globally

  -- or --

$ yarn global add lerna

```

Once you have installed both `yarn` and `lerna`, you can install the project dependencies by running the following command from within the project root directory:

```bash

  $ yarn

```

Note: You may come across the command sequence `lerna bootstrap` in the `lerna` documentation; this is equivalent to running `yarn` where both commands will pull down the necessary dependencies for the project and its packages.

## Contributing

Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct and the process for submitting pull requests.

## Changelog

Please see the [CHANGELOG.md](../CHANGELOG.md) for details on individual releases.