Skip to content

Commit 2eeecb1

Browse files
committed
docs: Add vendoring instructions to README
Fixes #124
1 parent 152a2fd commit 2eeecb1

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
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]).

0 commit comments

Comments
 (0)