Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace deprecated shortid dependancy #57

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Replace deprecated shortid dependancy #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
685ea94
Replace deprecated shortid dependancy
gabrielthomasjacobs Mar 20, 2023
62cada2
Update yarn.lock
gabrielthomasjacobs Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Upload S3 ☁️

This action upload directory to AWS S3 by [public read](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteAccessPermissionsReqd.html) and output key that generated by [shortid](https://github.com/dylang/shortid)
This action upload directory to AWS S3 by [public read](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteAccessPermissionsReqd.html) and output key that generated by [nanoid](https://github.com/ai/nanoid)

> Note - The last source_dir name(`foo/bar/will-be-replace`) will be replaced to the key generated as shortid.
> Note - The last source_dir name(`foo/bar/will-be-replace`) will be replaced to the key generated as nanoid.
The reason is that upload a new one every time and I want to access s3 with a new key value. If you want to upload a single file, be sure to **create a folder** and upload it.

## Usage
Expand Down Expand Up @@ -77,8 +77,8 @@ The following settings must be passed as environment variables as shown in the e
| `aws_key_id` | (Required) Your AWS Access Key. [More info here.](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html) |
| `aws_secret_access_key` | (Required) Your AWS Secret Access Key. [More info here.](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html) |
| `aws_bucket` | (Required) The name of the bucket you're upload to. |
| `source_dir` | (Required) The local directory (or file) you wish to upload to S3. The directory will replace to key generated by [shortid](https://github.com/dylang/shortid) in S3 |
| `destination_dir` | (Optional) The destination directory in S3<br />If this field is excluded a [shortid](https://github.com/dylang/shortid) will be generated |
| `source_dir` | (Required) The local directory (or file) you wish to upload to S3. The directory will replace to key generated by [nanoid](https://github.com/ai/nanoid) in S3 |
| `destination_dir` | (Optional) The destination directory in S3<br />If this field is excluded a [nanoid](https://github.com/ai/nanoid) will be generated |
| `endpoint` | (Optional) The endpoint URI to send requests to. [More info here.](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html) |

> To upload to the root directory, set `destination_dir: ''` in `action.yml`
Expand All @@ -87,5 +87,5 @@ The following settings must be passed as environment variables as shown in the e

| name | description |
| ------------------ | --------------------------------------------------------------------------------------- |
| `object_key` | Uploaded object key generated by [shortid](https://github.com/dylang/shortid) in Bucket |
| `object_key` | Uploaded object key generated by [nanoid](https://github.com/ai/nanoid) in Bucket |
| `object_locations` | Object Locations |
Loading