Skip to content

Commit

Permalink
docs: Add vendoring instructions to README
Browse files Browse the repository at this point in the history
Fixes #124
  • Loading branch information
mgalgs committed Aug 23, 2024
1 parent 152a2fd commit 2eeecb1
Showing 1 changed file with 29 additions and 0 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

0 comments on commit 2eeecb1

Please sign in to comment.