Skip to content

Commit 3967ab1

Browse files
committed
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
1 parent 152a2fd commit 3967ab1

File tree

3 files changed

+31
-7
lines changed

3 files changed

+31
-7
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,35 @@ For complete usage instructions and configuration reference, see our [`rollbar-d
3636

3737
See our [Releases](https://github.com/rollbar/rollbar-flutter/releases) page for a list of all releases and changes.
3838

39+
## Vendoring
40+
41+
Since Rollbar will no longer be publishing package updates to pub.dev, it's
42+
recommended that you "vendor" the Rollbar packages into your project so
43+
that you can have full control over package versions, pull in fixes from
44+
the community, etc. For example, the `rollbar_dart` package on pub.dev
45+
currently has an old `http` dependency, even though this has already been
46+
updated on the `main` branch.
47+
48+
To vendor this package in your project, it's recommended to add it as a
49+
`git` submodule. Typically you'll want to fork the repo so that you can
50+
make changes there, and use your fork for the submodule URL, like so:
51+
52+
```
53+
git submodule add https://github.com/<YOUR_USERNAME>/rollbar-flutter.git vendor/rollbar-flutter
54+
```
55+
56+
Next, remove `rollbar_flutter: ^X.X.X` from the `dependencies:` block in
57+
your `pubspec.yaml`, and add the following:
58+
59+
```yaml
60+
dependencies:
61+
...
62+
63+
# vendored packages
64+
rollbar_flutter:
65+
path: vendor/rollbar-flutter/rollbar_flutter
66+
```
67+
3968
## Help / Support
4069
4170
If you run into any issues, please email us at [[email protected]](mailto:[email protected]).

rollbar_dart/pubspec.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: rollbar_dart
22
description: Connect your Dart applications to Rollbar for error reporting.
33
version: 1.3.1
4+
publish_to: none
45
homepage: https://www.rollbar.com
56
documentation: https://docs.rollbar.com/docs/flutter#dart
67
repository: https://github.com/rollbar/rollbar-flutter
@@ -14,9 +15,6 @@ dependencies:
1415
sqlite3: ^1.7.0
1516
collection: ^1.16.0
1617
stack_trace: ^1.10.0
17-
rollbar_common: ^1.1.0
18-
19-
dependency_overrides:
2018
rollbar_common:
2119
path: ../rollbar_common
2220

rollbar_flutter/pubspec.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: rollbar_flutter
22
description: Connect your Flutter applications to Rollbar for error reporting.
33
version: 1.5.0
4+
publish_to: none
45
homepage: https://www.rollbar.com
56
documentation: https://docs.rollbar.com/docs/flutter#flutter
67
repository: https://github.com/rollbar/rollbar-flutter
@@ -15,10 +16,6 @@ dependencies:
1516
meta: ^1.7.0
1617
connectivity_plus: ^4.0.0
1718
sqlite3_flutter_libs: ^0.5.12
18-
rollbar_common: ^1.1.0
19-
rollbar_dart: ^1.3.0
20-
21-
dependency_overrides:
2219
rollbar_common:
2320
path: ../rollbar_common
2421
rollbar_dart:

0 commit comments

Comments
 (0)