Skip to content

Commit

Permalink
Merge branch 'release/1.0.0-rc.3'
Browse files Browse the repository at this point in the history
  • Loading branch information
msudgh committed Feb 10, 2024
2 parents 5a0f965 + e3db367 commit cd4ea54
Show file tree
Hide file tree
Showing 5 changed files with 310 additions and 298 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ pnpm-lock.yaml
.prettierrc
.eslintrc.json
.eslintignore
dist/tsconfig.build.tsbuildinfo
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,26 @@
[![Codecov Status](https://codecov.io/gh/msudgh/sync-cloud-storage/branch/main/graph/badge.svg?token=2BY6063VOY)](https://codecov.io/gh/msudgh/sync-cloud-storage)
[![License](https://img.shields.io/github/license/msudgh/sync-cloud-storage)](LICENSE)

A simple way to sync folders & files between a remote machine and a cloud provider's framework.
A simple way to sync folders & files between a remote machine and a cloud provider's storage.

Available for following cloud frameworks:

- [Serverless](https://serverless.com/)

> **Note**: This plugin is still in development and may not be stable. Use with caution.
## Installation

```bash
npm install --save sync-cloud-storage
```
1. [**ni**](https://github.com/antfu/ni): `ni sync-cloud-storage -D`
2. [**npm**](https://npmjs.com/): `npm i sync-cloud-storage -D`
3. [**yarn**](https://yarnpkg.com/): `yarn add sync-cloud-storage -D`
4. [**pnpm**](https://pnpm.io/): `pnpm add sync-cloud-storage -D`

## Why

- Uses the latest official cloud provider's SDK.
- Sync multiple storages at once.
- Sync tags and metadata of each storage.

## Usage

Expand All @@ -38,13 +47,3 @@ custom:
foo: bar
bar: foo
```
## Deployments
### [Granted](https://github.com/common-fate/granted) (assume)
By using the `assume` command, you can grant access to the plugin to deploy to your cloud framework.

```bash
assume
```
19 changes: 9 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,33 +36,32 @@
"preversion": "pnpm run build && pnpm run format"
},
"devDependencies": {
"@faker-js/faker": "8.4.0",
"@faker-js/faker": "8.4.1",
"@smithy/shared-ini-file-loader": "2.3.1",
"@types/jest": "29.5.11",
"@types/node": "20.11.10",
"@types/jest": "^29.5.12",
"@types/node": "20.11.17",
"@types/serverless": "3.12.22",
"@typescript-eslint/eslint-plugin": "6.20.0",
"@typescript-eslint/parser": "6.20.0",
"aws-sdk": "2.1546.0",
"@typescript-eslint/eslint-plugin": "6.21.0",
"@typescript-eslint/parser": "6.21.0",
"eslint": "8.56.0",
"eslint-config-prettier": "9.1.0",
"eslint-import-resolver-typescript": "3.6.1",
"eslint-plugin-import": "2.29.1",
"eslint-plugin-prettier": "5.1.3",
"http-server": "14.1.1",
"husky": "9.0.7",
"husky": "9.0.10",
"is-ci": "3.0.1",
"jest": "29.7.0",
"jest-mock-extended": "3.0.5",
"jsdoc": "4.0.2",
"prettier": "3.2.4",
"prettier": "3.2.5",
"serverless": "3.38.0",
"ts-jest": "29.1.2",
"typescript": "5.3.3"
},
"dependencies": {
"@aws-sdk/client-s3": "3.502.0",
"@aws-sdk/lib-storage": "3.502.0",
"@aws-sdk/client-s3": "3.511.0",
"@aws-sdk/lib-storage": "3.511.0",
"mrmime": "2.0.0",
"winston": "^3.11.0",
"zod": "3.22.4"
Expand Down
Loading

0 comments on commit cd4ea54

Please sign in to comment.