{"id":21428936,"url":"https://github.com/notcoffee418/s3-zip-upload","last_synced_at":"2025-07-14T10:32:38.550Z","repository":{"id":65158273,"uuid":"577465101","full_name":"NotCoffee418/s3-zip-upload","owner":"NotCoffee418","description":"GitHub Action to create a zip file from a folder and upload it to S3","archived":false,"fork":false,"pushed_at":"2024-09-27T15:37:35.000Z","size":6484,"stargazers_count":7,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-31T10:38:37.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotCoffee418.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-12T19:54:59.000Z","updated_at":"2024-09-27T15:34:56.000Z","dependencies_parsed_at":"2024-07-22T00:31:12.104Z","dependency_job_id":"0f939932-2cf6-468f-9cee-182b88d847f4","html_url":"https://github.com/NotCoffee418/s3-zip-upload","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"ee92357192bdc698f21a157c4f94a954e4ae160a"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fs3-zip-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fs3-zip-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fs3-zip-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fs3-zip-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotCoffee418","download_url":"https://codeload.github.com/NotCoffee418/s3-zip-upload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225970893,"owners_count":17553410,"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-11-22T22:15:17.683Z","updated_at":"2024-11-22T22:15:18.243Z","avatar_url":"https://github.com/NotCoffee418.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# S3 Zip Upload Action\n\nA GitHub Action for easily creating a zip file from a folder and uploading it to S3.  \nThis action can also be used to upload a pre-made zip file or any other single file.  \nIt supports Linux, Windows, and any other `runs-on` that can run Node. with content\ntype and user defined meta data\n\n## Features\n\n- Creates zip files and uploads them to S3\n- Can upload pre-made zip files or any other single files\n- Supports Linux, Windows, and other `runs-on` that can run Node\n- Easy to configure and use\n\n## Inputs\n\nAll inputs are environment variables. See the example below for usage.\n\n## Required Parameters\n\n| Parameter       | Description                  | Example                  |\n| --------------- | ---------------------------- | ------------------------ |\n| `AWS_SECRET_ID` | AWS access key ID            | `AKIAIOSFODNN7EXAMPLE`   |\n| `AWS_SECRET_KEY`| AWS secret access key        | `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` |\n| `BUCKET_NAME`   | AWS bucket name              | `my-bucket`              |\n| `SOURCE_PATH`   | Source file or directory     | `/path/to/source`        |\n| `DEST_FILE`     | Output file name or path     | `destination-file.zip`   |\n\n## Optional Parameters\n\n| Parameter       | Description                  | Default                  | Example             |\n| --------------- | ---------------------------- | ------------------------ | ------------------- |\n| `STORAGE_CLASS` | AWS storage class            | `STANDARD`               | `ONEZONE_IA`        |\n| `AWS_REGION`    | AWS region                   | `eu-central-1`           | `us-west-2`         |\n| `SOURCE_MODE`   | Source mode                  | `ZIP`                    | `FILE`              |\n| `S3_ENDPOINT`   | S3 endpoint override         | None                     | `https://s3.example.com` |\n| `CONTENT_TYPE`  | Content type metadata        | `application/zip` (for zip uploads) | `application/x-msdownload` |\n| `METADATA_KEY`  | user defined meta data key   | None                       | `x-amz-meta-version` |\n| `METADATA_VALUE` | user defined meta data value | None                      | `9.99` |\n\n## Example usage\n\n```yaml\nname: Upload to S3\non: [push]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Upload ZIP to S3\n        uses: NotCoffee418/s3-zip-upload@v1.5\n        env:\n          AWS_SECRET_ID: ${{ secrets.AWS_SECRET_ID }}\n          AWS_SECRET_KEY: ${{ secrets.AWS_SECRET_KEY }}\n          BUCKET_NAME: ${{ secrets.BUCKET_NAME }}\n          AWS_REGION: eu-central-1\n          SOURCE_MODE: ZIP\n          SOURCE_PATH: ./debug-override\n          DEST_FILE: debug-action.zip\n          CONTENT_TYPE: application/x-msdownload\n          METADATA_KEY: x-amz-meta-version\n          METADATA_VALUE: 9.99\n```\n\n## Manual action tests\n\nCopy .env.example to .env and modify it.\nCommands to run locally:\n\n```bash\nnpm run debug # run using your .env configuration\nnpm run debug file # uploads a dummy file as debug-override/dog1.jpg\nnpm run debug zip # uploads a dummy folder as debug-override/debug-action.zip\n```\n\n## Releasing new version\n\n1. Update the version in `package.json`\n2. `npm run build`\n3. Create a new tag and release on GitHub\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fs3-zip-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotcoffee418%2Fs3-zip-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fs3-zip-upload/lists"}