Merge pull request #59 from rollbar/metadata

Updated metadata for 0.3.0-beta release.
rollbar · Jul 25, 2022 · facd14f · facd14f
2 parents acc3954 + 00e8f2e
commit facd14f
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 56 deletions.
diff --git a/rollbar_common/CHANGELOG.md b/rollbar_common/CHANGELOG.md
@@ -1,3 +1,10 @@
-## 0.3.0-beta
+# Changelog
+
+## 0.3.1-beta
+
+- New language extensions on basic Dart types and functions.
+- Added a Tuple2 sealed and immutable data class.
+
+## 0.2.0-beta
 
 - Initial version.
diff --git a/rollbar_common/README.md b/rollbar_common/README.md
@@ -1,24 +1,23 @@
-<!-- 
+<!--
 This README describes the package. If you publish this package to pub.dev,
 this README's contents appear on the landing page for your package.
 
 For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages). 
+[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
 
 For general information about developing packages, see the Dart guide for
 [creating packages](https://dart.dev/guides/libraries/create-library-packages)
 and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages). 
+[developing packages and plugins](https://flutter.dev/developing-packages).
 -->
 
-# This package implements common components potentially used by other packages of the Rollbar SDK
+# This package implements common components used by other packages of the Rollbar SDK
 
 ## Features
 
-- internal SDK logger
-- service locator
+- useful data structures (sealed+immutable classes)
+- language extensions
 - connectivity monitor
-- abstractions for implementing common design patterns
 
 ## Getting started
 

diff --git a/rollbar_common/pubspec.yaml b/rollbar_common/pubspec.yaml
@@ -1,6 +1,6 @@
 name: rollbar_common
 description: Commons package used by the Rollbar Dart and Flutter SDKs for error reporting.
-version: 0.3.0-beta
+version: 0.3.1-beta
 homepage: https://www.rollbar.com
 documentation: https://docs.rollbar.com/docs/flutter#dart
 repository: https://github.com/rollbar/rollbar-flutter

diff --git a/rollbar_dart/CHANGELOG.md b/rollbar_dart/CHANGELOG.md
@@ -1,5 +1,19 @@
+# Changelog
+
+## 0.3.0-beta
+
+- Simplified API.
+- Persistent payloads.
+- More efficient usage of multithreading.
+- Fully type-safe, null-safe and endowed with immutability.
+- Fixed null-related crashes.
+- Fixed console logging disappearing when letting Rollbar catch uncaught errors.
+- Many more bug fixes.
+
 ## 0.2.0-beta
+
 - Added null-safety.
 
 ## 0.1.0-beta
+
 - Initial version of rollbar-dart.
diff --git a/rollbar_dart/README.md b/rollbar_dart/README.md
@@ -4,7 +4,7 @@
 
 This is a Dart-only implementation providing core notifier features. If you're building a [Flutter](https://flutter.dev/) application you should use [`rollbar-flutter`](../rollbar_flutter/README.md) instead, which adds Flutter-specific features to the core functionality of this library.
 
-## `rollbar-dart` is currently in Beta. We are looking for beta-testers and feedback!
+## `rollbar-dart` is currently in Beta. We are looking for beta-testers and feedback
 
 ## Usage
 
@@ -14,17 +14,17 @@ A simple usage example:
 import 'package:rollbar_dart/rollbar.dart';
 
 void main() async {
-  var config = (ConfigBuilder('<YOUR ROLLBAR TOKEN HERE>')
-        ..environment = 'production'
-        ..codeVersion = '1.0.0')
-      .build();
+    final config = Config(
+    accessToken: 'YOUR-ROLLBAR-ACCESSTOKEN',
+    package: 'rollbar_dart_example',
+  );
 
-  var rollbar = Rollbar(config);
+  await Rollbar.run(config);
 
   try {
     throw ArgumentError('An error occurred in the dart example app.');
   } catch (error, stackTrace) {
-    await rollbar.error(error, stackTrace);
+    await Rollbar.error(error, stackTrace);
   }
 }
 ```

diff --git a/rollbar_dart/pubspec.yaml b/rollbar_dart/pubspec.yaml
@@ -15,7 +15,7 @@ dependencies:
   sqlite3: ^1.5.1
   uuid: ^3.0.0
   logging: ^1.0.2
-  rollbar_common: ^0.3.0-beta
+  rollbar_common: ^0.3.1-beta
 
 dependency_overrides:
   rollbar_common:

diff --git a/rollbar_flutter/CHANGELOG.md b/rollbar_flutter/CHANGELOG.md
@@ -1,5 +1,19 @@
+# Changelog
+
+## 0.3.0-beta
+
+- Simplified API.
+- Persistent payloads.
+- More efficient usage of multithreading.
+- Fully type-safe, null-safe and endowed with immutability.
+- Fixed null-related crashes.
+- Fixed console logging disappearing when letting Rollbar catch uncaught errors.
+- Many more bug fixes.
+
 ## 0.2.0-beta
+
 - Added null-safety.
 
 ## 0.1.0-beta
+
 - Initial version of rollbar-flutter.
diff --git a/rollbar_flutter/README.md b/rollbar_flutter/README.md
@@ -2,72 +2,50 @@
 
 [Flutter](https://flutter.dev/) notifier for reporting exceptions, errors and log messages to [Rollbar](https://rollbar.com).
 
-## `rollbar-flutter` is currently in Beta. We are looking for beta-testers and feedback!
+## `rollbar-flutter` is currently in Beta. We are looking for beta-testers and feedback
 
 ## Usage
 
 A simple usage example:
 
 ```dart
 import 'package:flutter/services.dart';
-import 'package:rollbar_dart/rollbar.dart';
 import 'package:rollbar_flutter/rollbar.dart';
 
 Future<void> main() async {
-  var config = (ConfigBuilder('<YOUR ROLLBAR TOKEN HERE>')
-        ..environment = 'production'
-        ..codeVersion = '1.0.0'
-        ..handleUncaughtErrors = true)
-      .build();
-
-  await RollbarFlutter.run(config, (_rollbar) {
-    runApp(MyApp());
-  });
-}
+  const config = Config(
+    accessToken: 'YOUR-ROLLBAR-ACCESSTOKEN',
+    package: 'rollbar_flutter_example',
+  );
 
-class MyApp extends StatelessWidget {
-  // Your application code here...
+  await RollbarFlutter.run(config, () => runApp(const MyApp()));
 }
 ```
 
 With this setup, `rollbar-flutter` will automatically catch and report any unhandled errors in your application.
 
-You can also use the rollbar instance to explicitly report errors or messages to Rollbar:
+You can also explicitly report errors or messages to Rollbar:
 
 ```dart
-import 'package:flutter/services.dart';
-import 'package:rollbar_flutter/rollbar.dart';
-
-Future<void> main() async {
-  var config = (ConfigBuilder('<YOUR ROLLBAR TOKEN HERE>')
-        ..environment = 'production'
-        ..codeVersion = '1.0.0'
-        ..handleUncaughtErrors = true)
-      .build();
-
-  await RollbarFlutter.run(config, (rollbar) async {
-    await rollbar.infoMsg('Nothing out of the ordinary so far...');
-  });
-}
+await Rollbar.info('Nothing out of the ordinary so far...');
 ```
 
 See the [`example` directory](./example/) for a complete example.
 
 ## Compatibility
 
-- Flutter 1: version **1.20.4** and above
-- Flutter 2: version **2.0.5** and above
+- Flutter 2: version **2.8.1** and above
 
 Logging version-specific issues, even outside of the supported versions, is welcome and they will be fixed whenever possible.
 
 ## Platform Support
 
-* Android: Yes
-* iOS: Yes
-* Web: No
-* Windows: No
-* macOS: No
-* Linux: No
+- Android: Yes
+- iOS: Yes
+- Web: No
+- Windows: No
+- macOS: No
+- Linux: No
 
 Additional platforms will be prioritized based on feedback from users.
 

diff --git a/rollbar_flutter/pubspec.yaml b/rollbar_flutter/pubspec.yaml
@@ -12,10 +12,10 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
+  meta: ^1.7.0
   connectivity_plus: ^2.1.0
   sqlite3_flutter_libs: ^0.5.8
-  meta: ^1.7.0
-  rollbar_common: ^0.3.0-beta
+  rollbar_common: ^0.3.1-beta
   rollbar_dart: ^0.3.0-beta
 
 dependency_overrides: