umzug - npm Package Compare versions

Comparing version 3.0.0-beta-cli.19 to 3.0.0

package.json

 {
 	"name": "umzug",
-	"version": "3.0.0-beta-cli.19",
+	"version": "3.0.0",
 	"description": "Framework-agnostic migration tool for Node",
@@ -51,3 +51,3 @@ "keywords": [
 		"source-map-support": "0.5.21",
-		"sqlite3": "5.0.2",
+		"sqlite3": "npm:@vscode/sqlite3@^5.0.7",
 		"strip-ansi": "6.0.1",
@@ -76,2 +76,6 @@ "ts-jest": "27.1.1",
 		{
+			"name": "Misha Kaletsky",
+			"email": "[e-mail]"
+		},
+		{
 			"name": "Jukka Hyytiälä",
@@ -78,0 +82,0 @@ "email": "[e-mail]"

README.md

 # Umzug
 
 [![Build Status](https://badgen.net/github/checks/sequelize/umzug/master)](https://github.com/sequelize/umzug/actions?query=workflow%3ACI)
-[![npm (stable)](https://badgen.net/npm/v/umzug)](https://www.npmjs.com/package/umzug)
-[![npm (beta)](https://badgen.net/npm/v/umzug/beta)](https://www.npmjs.com/package/umzug/v/beta)
+[![npm](https://badgen.net/npm/v/umzug)](https://www.npmjs.com/package/umzug)
 [![npm (downloads)](https://badgen.net/npm/dm/umzug)](https://npmjs.com/package/umzug)
@@ -10,16 +9,2 @@
 
-_Note: master represents the next major version of umzug - v3 - which is currently in beta. For the stable version, please refer to the [v2.x branch](https://github.com/sequelize/umzug/tree/v2.x)._
-
-To install the v3-beta package:
-
-```
-npm install umzug@beta
-```
-
-To install the stable package (v2.x):
-
-```
-npm install umzug
-```
-
 ## Highlights
@@ -40,5 +25,7 @@
 
+_Note: these are the docs for the latest version of umzug, which has several breaking changes from v2.x. See [the upgrading section](#upgrading-from-v2x) for a migration guide. For the previous stable version, please refer to the [v2.x branch](https://github.com/sequelize/umzug/tree/v2.x)._
+
 ### Minimal Example
 
-The following example uses a Sqlite database through sequelize and persists the migration data in the database itself through the sequelize storage. There are several more involved examples covering a few different scenarios in the [examples folder](./examples).
+The following example uses a Sqlite database through sequelize and persists the migration data in the database itself through the sequelize storage. There are several more involved examples covering a few different scenarios in the [examples folder](./examples). Note that although this uses Sequelize, Umzug isn't coupled to Sequelize, it's just one of the (most commonly-used) supported storages.
 
@@ -151,6 +138,6 @@ ```js
 
-The beta version of Umzug is available on npm by specifying the correct tag:
+Umzug is available on npm by specifying the correct tag:
 
 ```bash
-npm install umzug@beta
+npm install umzug
 ```
@@ -459,4 +446,8 @@
 
-The `context` parameter replaces `params`, and is passed in as a property to migration functions as an options object, alongs side `name` and `path`. This means the signature for migrations, which in v2 was `(context) => Promise<void>`, has changed slightly in v3, to `({ name, path, context }) => Promise<void>`. The `resolve` function can also be used to upgrade your umzug version to v3 when you have existing v2-compatible migrations:
+The `context` parameter replaces `params`, and is passed in as a property to migration functions as an options object, alongs side `name` and `path`. This means the signature for migrations, which in v2 was `(context) => Promise<void>`, has changed slightly in v3, to `({ name, path, context }) => Promise<void>`.
 
+#### Handling existing v2-format migrations
+
+The `resolve` function can also be used to upgrade your umzug version to v3 when you have existing v2-compatible migrations:
+
 ```js
@@ -600,3 +591,3 @@ const { Umzug } = require('umzug');
 
-🚧🚧🚧 The CLI is new to Umzug v3 beta and is not yet stable. Feedback on it is welcome in [discussions](https://github.com/sequelize/umzug/discussions) 🚧🚧🚧
+🚧🚧🚧 The CLI is new to Umzug v3. Feedback on it is welcome in [discussions](https://github.com/sequelize/umzug/discussions) 🚧🚧🚧
 
@@ -603,0 +594,0 @@ Umzug instances provide a `.runAsCLI()` method. When called, this method will automatically cause your program to become a complete CLI, with help text and such:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

131283

increased by0.05%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Number of lines in readme file

823

decreased by-1.08%

No dependency changes