From fe32351e0c185a1f2f07cd3b3ad67a80079ee120 Mon Sep 17 00:00:00 2001 From: Maximilian Fischer Date: Tue, 13 Oct 2020 11:12:39 +0200 Subject: [PATCH] renamed 1.0.28 to 2.0.0 (#480) - Added warning to parse_server_sdk changelog - Added warning to parse_server_sdk readme --- docs/migrate-1-0-28.md | 54 +------------------ docs/migrate-2-0-0.md | 53 ++++++++++++++++++ packages/dart/CHANGELOG.md | 7 ++- packages/dart/README.md | 3 +- .../dart/lib/src/base/parse_constants.dart | 2 +- packages/dart/pubspec.yaml | 2 +- packages/flutter/CHANGELOG.md | 5 +- packages/flutter/README.md | 2 +- packages/flutter/pubspec.yaml | 4 +- 9 files changed, 71 insertions(+), 61 deletions(-) mode change 100644 => 120000 docs/migrate-1-0-28.md create mode 100644 docs/migrate-2-0-0.md diff --git a/docs/migrate-1-0-28.md b/docs/migrate-1-0-28.md deleted file mode 100644 index e7771ad91..000000000 --- a/docs/migrate-1-0-28.md +++ /dev/null @@ -1,53 +0,0 @@ -# Migrate your Flutter application to version 1.0.28 - -Starting with version 1.0.28, this repository is now separated in a pure dart (parse_server_sdk) and a flutter package (parse_server_sdk_flutter). -This was done in order to provide a dart package for the parse-server, while keeping maintenance simple. -You can find both packages in the package directory. - -### 1. pubspec.yaml -In your projects pubspec.yaml at the dependencies section, you have to change -``` -dependencies: - parse_server_sdk: ^1.0.27 -``` -to -``` -dependencies: - parse_server_sdk_flutter: ^1.0.28 -``` -This is the current released version of the parse_server_sdk_flutter package: [![pub package](https://img.shields.io/pub/v/parse_server_sdk_flutter.svg)](https://pub.dev/packages/parse_server_sdk_flutter) - -### 2. imports -As the package name changed, you have to change -``` -import 'package:parse_server_sdk/parse_server_sdk.dart'; -``` - to -``` -import 'package:parse_server_sdk_flutter/parse_server_sdk.dart'; -``` -in every file. - -It is recommended to do so by the replacement feature of your IDE. - -### optional: provide app information on web -As flutter web is now in beta, this SDK aims to be web compatible. -But there are some parts completely different on web. For example, the wep-app cant determine it's name, version or packagename. -That's why you should provide this information on web. -```dart -Parse().initialize( - ... - appName: kIsWeb ? "MyApplication" : null, - appVersion: kIsWeb ? "Version 1" : null, - appPackageName: kIsWeb ? "com.example.myapplication" : null, -); -``` - -### optional: adjust your tests -You tests might fail if the package tries to automatically discover facts like you applications name, version, package name or the default file directory. -You can avoid this automatic discovery by providing values for `appName`, `appVersion`, `appPackageName` as well as `fileDirectory` at you `Parse().initialize()` call. - -### changed network library -In order to provide a `ProgressCallback` for heavy file operations, -the network library was switched from [http](https://pub.dev/packages/http) to [dio](https://pub.dev/packages/dio). -There should be no breaking changes regarding this change, except if you are overriding the `ParseHTTPClient`. \ No newline at end of file diff --git a/docs/migrate-1-0-28.md b/docs/migrate-1-0-28.md new file mode 120000 index 000000000..fd18cf428 --- /dev/null +++ b/docs/migrate-1-0-28.md @@ -0,0 +1 @@ +migrate-2-0-0.md \ No newline at end of file diff --git a/docs/migrate-2-0-0.md b/docs/migrate-2-0-0.md new file mode 100644 index 000000000..802859310 --- /dev/null +++ b/docs/migrate-2-0-0.md @@ -0,0 +1,53 @@ +# Migrate your Flutter application to version 2.0.0 + +Starting with version 2.0.0, this repository is now separated in a pure dart (parse_server_sdk) and a flutter package (parse_server_sdk_flutter). +This was done in order to provide a dart package for the parse-server, while keeping maintenance simple. +You can find both packages in the package directory. + +### 1. pubspec.yaml +In your projects pubspec.yaml at the dependencies section, you have to change +``` +dependencies: + parse_server_sdk: ^1.0.27 +``` +to +``` +dependencies: + parse_server_sdk_flutter: ^2.0.0 +``` +This is the current released version of the parse_server_sdk_flutter package: [![pub package](https://img.shields.io/pub/v/parse_server_sdk_flutter.svg)](https://pub.dev/packages/parse_server_sdk_flutter) + +### 2. imports +As the package name changed, you have to change +``` +import 'package:parse_server_sdk/parse_server_sdk.dart'; +``` + to +``` +import 'package:parse_server_sdk_flutter/parse_server_sdk.dart'; +``` +in every file. + +It is recommended to do so by the replacement feature of your IDE. + +### optional: provide app information on web +As flutter web is now in beta, this SDK aims to be web compatible. +But there are some parts completely different on web. For example, the wep-app cant determine it's name, version or packagename. +That's why you should provide this information on web. +```dart +Parse().initialize( + ... + appName: kIsWeb ? "MyApplication" : null, + appVersion: kIsWeb ? "Version 1" : null, + appPackageName: kIsWeb ? "com.example.myapplication" : null, +); +``` + +### optional: adjust your tests +You tests might fail if the package tries to automatically discover facts like you applications name, version, package name or the default file directory. +You can avoid this automatic discovery by providing values for `appName`, `appVersion`, `appPackageName` as well as `fileDirectory` at you `Parse().initialize()` call. + +### changed network library +In order to provide a `ProgressCallback` for heavy file operations, +the network library was switched from [http](https://pub.dev/packages/http) to [dio](https://pub.dev/packages/dio). +There should be no breaking changes regarding this change, except if you are overriding the `ParseHTTPClient`. \ No newline at end of file diff --git a/packages/dart/CHANGELOG.md b/packages/dart/CHANGELOG.md index a5803d9ef..ecd6bc544 100644 --- a/packages/dart/CHANGELOG.md +++ b/packages/dart/CHANGELOG.md @@ -1,4 +1,6 @@ -## 1.0.28 +## 2.0.0 +##### Warning: This release contains breaking changes. If you are using flutter you should migrate using *[this](https://github.com/parse-community/Parse-SDK-Flutter/blob/release/2.0.0/docs/migrate-2-0-0.md)* guide. + - Added full web support - split this package in a dart and a flutter one - [flutter package](https://pub.dev/packages/parse_server_sdk_flutter) @@ -7,6 +9,9 @@ - Bug fixes - general improvements +## 1.0.28 +1.0.28 was renamed to 2.0.0 + ## 1.0.27 User login / signUp / loginAnonymous delete SessionId stored in device before calling server diff --git a/packages/dart/README.md b/packages/dart/README.md index b57447dbc..268705072 100644 --- a/packages/dart/README.md +++ b/packages/dart/README.md @@ -6,6 +6,7 @@ --- **This is now a dart package. The Flutter package was moved [here](https://pub.dev/packages/parse_server_sdk_flutter).** +If you are using flutter you should migrate using [this](https://github.com/parse-community/Parse-SDK-Flutter/blob/release/2.0.0/docs/migrate-2-0-0.md) guide. **THIS README IS WORK IN PROGRESS!** Help out to improve this README on [GitHub](https://github.com/parse-community/Parse-SDK-Flutter/edit/master/packages/dart/README.md). @@ -19,7 +20,7 @@ This is a work in progress and we are consistently updating it. Please let us kn To install, either add to your pubspec.yaml ```yml dependencies: - parse_server_sdk: ^1.0.28 + parse_server_sdk: ^2.0.0 ``` or clone this repository and add to your project. As this is an early development with multiple contributors, it is probably best to download/clone and keep updating as an when a new feature is added. diff --git a/packages/dart/lib/src/base/parse_constants.dart b/packages/dart/lib/src/base/parse_constants.dart index 25fe69010..d60d0daed 100644 --- a/packages/dart/lib/src/base/parse_constants.dart +++ b/packages/dart/lib/src/base/parse_constants.dart @@ -1,7 +1,7 @@ part of flutter_parse_sdk; // Library -const String keySdkVersion = '1.0.28'; +const String keySdkVersion = '2.0.0'; const String keyLibraryName = 'Flutter Parse SDK'; // End Points diff --git a/packages/dart/pubspec.yaml b/packages/dart/pubspec.yaml index d78d35b1a..5fff4633e 100644 --- a/packages/dart/pubspec.yaml +++ b/packages/dart/pubspec.yaml @@ -1,6 +1,6 @@ name: parse_server_sdk description: Dart plugin for Parse Server, (https://parseplatform.org), (https://back4app.com) -version: 1.0.28 +version: 2.0.0 homepage: https://github.com/phillwiggins/flutter_parse_sdk environment: diff --git a/packages/flutter/CHANGELOG.md b/packages/flutter/CHANGELOG.md index 57713cde8..c49caff1f 100644 --- a/packages/flutter/CHANGELOG.md +++ b/packages/flutter/CHANGELOG.md @@ -1,2 +1,5 @@ -## 1.0.28 +## 2.0.0 +First release. +## 1.0.28 +Renamed to 2.0.0 diff --git a/packages/flutter/README.md b/packages/flutter/README.md index 5ee3de12e..29bb5f11b 100644 --- a/packages/flutter/README.md +++ b/packages/flutter/README.md @@ -14,7 +14,7 @@ This is a work in progress and we are consistently updating it. Please let us kn To install, either add to your pubspec.yaml ```yml dependencies: - parse_server_sdk: ^1.0.28 + parse_server_sdk: ^2.0.0 ``` or clone this repository and add to your project. As this is an early development with multiple contributors, it is probably best to download/clone and keep updating as an when a new feature is added. diff --git a/packages/flutter/pubspec.yaml b/packages/flutter/pubspec.yaml index 16bfd4ee2..966c814e6 100644 --- a/packages/flutter/pubspec.yaml +++ b/packages/flutter/pubspec.yaml @@ -1,6 +1,6 @@ name: parse_server_sdk_flutter description: Flutter plugin for Parse Server, (https://parseplatform.org), (https://back4app.com) -version: 1.0.28 +version: 2.0.0 homepage: https://github.com/phillwiggins/flutter_parse_sdk environment: @@ -10,7 +10,7 @@ dependencies: flutter: sdk: flutter - parse_server_sdk: ^1.0.28 + parse_server_sdk: ^2.0.0 # Networking dio: ^3.0.10