https://github.com/enamhasan/github-s3-sync

Step By step sync between Github and AWS S3 bucket using Github Actions
https://github.com/enamhasan/github-s3-sync

aws-s3 ci-cd-pipeline github-actions s3-bucket

Last synced: 10 days ago
JSON representation

Step By step sync between Github and AWS S3 bucket using Github Actions

• Host: GitHub
• URL: https://github.com/enamhasan/github-s3-sync
• Owner: enamhasan
• Created: 2023-10-05T19:16:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-03T02:19:12.000Z (about 1 month ago)
• Last Synced: 2025-01-03T02:27:13.006Z (about 1 month ago)
• Topics: aws-s3, ci-cd-pipeline, github-actions, s3-bucket
• Homepage:
• Size: 8.79 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GitHub-S3-Sync

Step-by-step sync of a static website or files between Github and AWS S3 bucket using Github Actions.

# Step 1: Create S3 bucket

* To create a new bucket, you can navigate to the AWS S3 console, and click on the ‘Create Bucket’ button.

* Click on the properties tab of the newly created bucket and enable the static website option.

* Click on the permission tab and make it public by unchecking "Block all public access"

* On the Bucket policy section paste this policy and save.

```

{

    "Version": "2012-10-17",

    "Statement": [

        {

            "Sid": "PublicReadGetObject",

            "Effect": "Allow",

            "Principal": "*",

            "Action": "s3:GetObject",

            "Resource": "arn:aws:s3:::bucket-name/*"

        }

    ]

}

```

# Step 2: Create an IAM user and generate an Access Key

* From AWS IAM create a new user

* In the Set Permission step select "Attach policies directly"

* From the list of Permission policies search and find "AmazonS3FullAccess" and select it and hit the Create user button.

* Click Create access keys for the user and download the access key CSV file or copy and save it somewhere. 

# Step 3: Configure GitHub repo Create with action workflow file to sync on Push.

 * On your GitHub Repo Click on settings.

 * Select Secrets from the left sidebar

 * Create three Secret Keys for AWS_S3_BUCKET, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

 * On your GitHub repo click on Actions and a workflow file by clicking on the New Workflow Button.

 * Paste the bellow code in the action workflow file 

```

name: uploadToS3

on:

  push:

    branches: [ "main" ]

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout

      uses: actions/checkout@v3

    - name: Configure AWS Credentials

      uses: aws-actions/configure-aws-credentials@v2

      with:

        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}

        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

        aws-region: 'us-east-2'

    - name: Install AWS CLI

      run: sudo apt-get install -y awscli

    - name: Sync files to S3

      run: |

        aws s3 sync ./ s3://${{ secrets.AWS_S3_BUCKET }} --delete

```

We are done. GitHub will upload the files to your S3 Bucket every time you push your update to GitHub.