Skip to content

Commit

Permalink
docs: Add vendoring instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgalgs committed Aug 23, 2024
1 parent 152a2fd commit fd29a63
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,37 @@ 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 the versions being pulled in, pull in
fixes from the community, etc. For example, the `rollbar_dart` package on
pub.dev currently has old http dependencies, 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, like so:

```
git submodule add https://github.com/rollbar/rollbar-flutter.git vendor/rollbar-flutter
```

You might also want to fork the repo and use your fork URL in the above
command.

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 fd29a63

Please sign in to comment.