{"id":14110435,"url":"https://github.com/matthprost/s3-deploy-bucket-website-action","last_synced_at":"2025-05-02T02:30:46.865Z","repository":{"id":119386417,"uuid":"379966606","full_name":"matthprost/s3-deploy-bucket-website-action","owner":"matthprost","description":"Easily deploy any static website on your S3 bucket.","archived":false,"fork":false,"pushed_at":"2021-07-02T12:23:03.000Z","size":47,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T21:09:58.580Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matthprost.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-06-24T15:12:59.000Z","updated_at":"2021-07-07T14:27:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"2b3dbe35-6292-4c11-8323-e37b4c7b5084","html_url":"https://github.com/matthprost/s3-deploy-bucket-website-action","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthprost%2Fs3-deploy-bucket-website-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthprost%2Fs3-deploy-bucket-website-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthprost%2Fs3-deploy-bucket-website-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthprost%2Fs3-deploy-bucket-website-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthprost","download_url":"https://codeload.github.com/matthprost/s3-deploy-bucket-website-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251972433,"owners_count":21673602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-14T10:02:51.007Z","updated_at":"2025-05-02T02:30:45.402Z","avatar_url":"https://github.com/matthprost.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# S3 Bucket Website Deploy\n\nAction that will create a bucket if it doesn't exist and upload your files into it.\n\nHere is process in order:\n\n1. Try to create bucket\n2. Compress your files using compatible tool (only gzip)(Optional)\n3. Set Bucket Website configuration\n4. Set Website Policy\n5. Upload files from source folder into bucket\n\n## How to test locally\n\n```shell\nenv -i \\\n  INPUT_S3_ACCESS_KEY={YOUR ACCESS KEY} \\\n  INPUT_S3_SECRET_KEY={YOUR SECRET KEY} \\\n  INPUT_S3_ENDPOINT=\"s3.fr-par.scw.cloud\" \\ \n  INPUT_S3_REGION=\"fr-par\" \\\n  INPUT_BUCKET_NAME=\"my-bucket-of-test-1234\" \\\n  INPUT_WEBSITE_CONFIG_PATH=\".bucket-website.json\" \\\n  INPUT_BUCKET_POLICY_CONFIG_PATH=\".bucket-policy.json.tpl\" \\\n  INPUT_SOURCE_DIRECTORY=\".\" \\\n  INPUT_GITHUB_WORKSPACE=\".\" \\\n  INPUT_SYNC_ARGS=\"--delete\" \\\n  INPUT_COMPRESS_TOOL=\"gzip\" ./entrypoint.sh\n```\n\n### Variables\n\n**INPUT_S3_ACCESS_KEY**: S3 access key.\n\n**INPUT_S3_SECRET_KEY**: S3 secret key. Required.\n\n**INPUT_S3_ENDPOINT**: S3 full endpoint. Ex: **s3.fr-par.scw.cloud** or **s3.us-west-2.amazonaws.com**.\n\n**INPUT_S3_REGION**: Region of your bucket. Ex: **fr-par** or **nl-ams** or **us-west**\n\n**INPUT_BUCKET_NAME**: Name of your bucket.\n\n**INPUT_WEBSITE_CONFIG_PATH**: Root path of your bucket website configuration file. It should be a `.json`. You can find an example file [here](.bucket-website.json).\n\n**INPUT_BUCKET_POLICY_CONFIG_PATH**: Root path of your bucket website policy file. It should be a `.json.tpl`. You can find an example file [here](.bucket-website.json).\n\n**INPUT_SOURCE_DIRECTORY**: This is the root path of the files that will be uploaded to your S3 Bucket.\n\n**INPUT_SYNC_ARGS**: Arguments that will be added in sync command: `aws s3 sync ./ s3://bucket-name ${SYNC_ARGS}`\n\n**INPUT_COMPRESS_TOOL**: You can specify a compression tool that will be applied to your file before uploading them. Action will automatically add encoding header if this option is set. This is optional parameter. Only `gzip` available.\n\n## Contributions\n\nOriginal Author: Rémy Léone - https://github.com/remyleone/scw-s3-action\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthprost%2Fs3-deploy-bucket-website-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthprost%2Fs3-deploy-bucket-website-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthprost%2Fs3-deploy-bucket-website-action/lists"}