Skip to content

Commit b25c73f

Browse files
committed
docs: update documentation about migration to new version
1 parent 8d28850 commit b25c73f

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

packages/serverless-offline-s3/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,22 @@ plugins:
2626
2727
[See example](../../tests/serverless-plugins-integration/README.md#s3)
2828
29+
## Migrating from v7 to v8
30+
31+
This version requires Serverless Framework v4 and serverless-offline v14.4.0+.
32+
33+
### Breaking Changes
34+
35+
- Requires `serverless-offline: "^14.4.0 || >=14"`
36+
- Uses new Serverless v4 plugin API for logging
37+
- Node.js 18+ required
38+
39+
### Upgrade Steps
40+
41+
1. Update serverless to v4: `npm install serverless@^4.0.0`
42+
2. Update serverless-offline to v14.4.0+: `npm install serverless-offline@^14.4.0`
43+
3. Update this plugin: `npm install serverless-offline-s3@^8.0.0`
44+
2945
## How it works?
3046

3147
To be able to emulate AWS S3 Bucket on local machine there should be some bucket system actually running. One of the existing implementations suitable for the task is [Minio](https://github.com/minio/minio).

packages/serverless-offline-sqs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,22 @@ plugins:
2626
2727
[See example](../../tests/serverless-plugins-integration/README.md#sqs)
2828
29+
## Migrating from v8 to v9
30+
31+
This version requires Serverless Framework v4 and serverless-offline v14.4.0+.
32+
33+
### Breaking Changes
34+
35+
- Requires `serverless-offline: "^14.4.0 || >=14"`
36+
- Uses new Serverless v4 plugin API for logging
37+
- Node.js 18+ required
38+
39+
### Upgrade Steps
40+
41+
1. Update serverless to v4: `npm install serverless@^4.0.0`
42+
2. Update serverless-offline to v14.4.0+: `npm install serverless-offline@^14.4.0`
43+
3. Update this plugin: `npm install serverless-offline-sqs@^9.0.0`
44+
2945
## How it works?
3046

3147
To be able to emulate AWS SQS queue on local machine there should be some queue system actually running. One of the existing implementations suitable for the task is [ElasticMQ](https://github.com/adamw/elasticmq).

0 commit comments

Comments
 (0)