Skip to content

Commit

Permalink
feat: Unpublish rollbar_{dart,flutter} and add vendoring instructions
Browse files Browse the repository at this point in the history
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
  • Loading branch information
mgalgs committed Sep 12, 2024
1 parent 152a2fd commit 3967ab1
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 7 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<YOUR_USERNAME>/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 [[email protected]](mailto:[email protected]).
Expand Down
4 changes: 1 addition & 3 deletions rollbar_dart/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
5 changes: 1 addition & 4 deletions rollbar_flutter/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down

0 comments on commit 3967ab1

Please sign in to comment.