bene2k1 / s3-docusaurus-sync-action

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub Action to build docusaurus site and deploy it on Scaleway Object Storage

This is a customized version of the s3-sync-action that uses the vanilla AWS CLI to sync a directory (either from your repository or generated during your workflow) with a remote S3 bucket. It also runs the command: yarn run build to build the docusaurs site for deployment.

Configuration

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

Key Value Suggested Type Required Notes
SCW_BUCKET_REGION The region where you created your bucket. Set to Full list of regions here.) env Yes
AWS_S3_BUCKET The bucket name you want to publish the site to env or secret env Yes This does not have to be in the secrets but it makes it easier to manage
SCW_ACCESS_KEY_ID Your Scaleway Access Key. More info here.) secret env Yes
SCW_SECRET_ACCESS_KEY Your Scaleway Secret Access Key. More info here. secret env Yes

About

License:Apache License 2.0


Languages

Language:Shell 82.8%Language:Dockerfile 17.2%