From 3967ab184c8e0fa4e1b302a85d46a8c36f8c3956 Mon Sep 17 00:00:00 2001 From: Mitchel Humpherys Date: Fri, 23 Aug 2024 15:22:24 -0700 Subject: [PATCH] feat: Unpublish rollbar_{dart,flutter} and add vendoring instructions Since Rollbar will no longer be publishing package updates to pub.dev, it will be helpful for many users to "vendor" the Rollbar packages into their projects so that they can have full control over package versions, pull in fixes from the community, etc. For example, the rollbar_dart package on pub.dev currently has an old http dependency, even though this has already been updated on the main branch. Add instructions to the README for vendoring rollbar_flutter into a user project, and change the internal rollbar_{dart,flutter} dependencies to be "path" dependencies (pulling from within this repo) rather than "hosted" (pulling from pub.dev). Fixes #124 --- README.md | 29 +++++++++++++++++++++++++++++ rollbar_dart/pubspec.yaml | 4 +--- rollbar_flutter/pubspec.yaml | 5 +---- 3 files changed, 31 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4f3e59d..a8d43bb 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,35 @@ For complete usage instructions and configuration reference, see our [`rollbar-d See our [Releases](https://github.com/rollbar/rollbar-flutter/releases) page for a list of all releases and changes. +## Vendoring + +Since Rollbar will no longer be publishing package updates to pub.dev, it's +recommended that you "vendor" the Rollbar packages into your project so +that you can have full control over package versions, pull in fixes from +the community, etc. For example, the `rollbar_dart` package on pub.dev +currently has an old `http` dependency, even though this has already been +updated on the `main` branch. + +To vendor this package in your project, it's recommended to add it as a +`git` submodule. Typically you'll want to fork the repo so that you can +make changes there, and use your fork for the submodule URL, like so: + +``` +git submodule add https://github.com//rollbar-flutter.git vendor/rollbar-flutter +``` + +Next, remove `rollbar_flutter: ^X.X.X` from the `dependencies:` block in +your `pubspec.yaml`, and add the following: + +```yaml +dependencies: + ... + + # vendored packages + rollbar_flutter: + path: vendor/rollbar-flutter/rollbar_flutter +``` + ## Help / Support If you run into any issues, please email us at [support@rollbar.com](mailto:support@rollbar.com). diff --git a/rollbar_dart/pubspec.yaml b/rollbar_dart/pubspec.yaml index 55d935c..adb7382 100644 --- a/rollbar_dart/pubspec.yaml +++ b/rollbar_dart/pubspec.yaml @@ -1,6 +1,7 @@ name: rollbar_dart description: Connect your Dart applications to Rollbar for error reporting. version: 1.3.1 +publish_to: none homepage: https://www.rollbar.com documentation: https://docs.rollbar.com/docs/flutter#dart repository: https://github.com/rollbar/rollbar-flutter @@ -14,9 +15,6 @@ dependencies: sqlite3: ^1.7.0 collection: ^1.16.0 stack_trace: ^1.10.0 - rollbar_common: ^1.1.0 - -dependency_overrides: rollbar_common: path: ../rollbar_common diff --git a/rollbar_flutter/pubspec.yaml b/rollbar_flutter/pubspec.yaml index 27ef884..f22df5f 100644 --- a/rollbar_flutter/pubspec.yaml +++ b/rollbar_flutter/pubspec.yaml @@ -1,6 +1,7 @@ name: rollbar_flutter description: Connect your Flutter applications to Rollbar for error reporting. version: 1.5.0 +publish_to: none homepage: https://www.rollbar.com documentation: https://docs.rollbar.com/docs/flutter#flutter repository: https://github.com/rollbar/rollbar-flutter @@ -15,10 +16,6 @@ dependencies: meta: ^1.7.0 connectivity_plus: ^4.0.0 sqlite3_flutter_libs: ^0.5.12 - rollbar_common: ^1.1.0 - rollbar_dart: ^1.3.0 - -dependency_overrides: rollbar_common: path: ../rollbar_common rollbar_dart: