GitHub Action to sync a directory with a remote GCP Storage bucket

GitHub Action to GCP Storage Bucket

This simple action uses the gsutil tool to sync a directory (either from your repository or generated during your workflow) with a remote GCP Storage bucket.

Usage

workflow.yml

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

Mostly gsutil rsync flags are optional to allow for maximum customizability and must be provided by you via args:.

Example

• -d mirror source and destination. See.

name: gcp-storage-sync

on:
  push:
    branches:
    - master

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: weslenng/gcp-storage-sync@master
        with:
          args: -d
        env:
          GCP_SERVICE_ACCOUNT_KEY_FILE: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY_FILE }}
          GCP_STORAGE_BUCKET: ${{ secrets.GCP_STORAGE_BUCKET }}
          SOURCE_DIR: "public"

Configuration

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

License

This project is distributed under the MIT license.

Thanks to s3-sync.