Merge pull request #62 from bugsnag/releases/v1.0.0

Releases/v1.0.0

.buildkite/pipeline.yml

@@ -0,0 +1,109 @@
+agents:
+  queue: macos-12-arm
+
+steps:
+
+  - label: ":test_tube: 3.10.0"
+    timeout_in_minutes: 10
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+    commands:
+      - make test
+
+  - label: ":lint-roller: 3.10.0"
+    timeout_in_minutes: 10
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+    commands:
+      - make lint
+
+  #
+  # iOS
+  #
+  - label: Build iOS Test Fixture
+    key: "ios-fixture-3-10-0"
+    timeout_in_minutes: 20
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+    commands:
+      - bundle install
+      - pod repo update trunk
+      - features/scripts/generate_fixture.sh
+      - features/scripts/build_ios_app.sh
+    plugins:
+      artifacts#v1.5.0:
+        upload:
+          - "features/fixtures/mazerunner/build/ios/ipa/mazerunner.ipa"
+
+  - label: ':bitbar: iOS 14 end-to-end tests'
+    depends_on: "ios-fixture-3-10-0"
+    timeout_in_minutes: 20
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+    agents:
+      queue: opensource
+    plugins:
+      artifacts#v1.5.0:
+        download: "features/fixtures/mazerunner/build/ios/ipa/mazerunner.ipa"
+        upload: "maze_output/failed/**/*"
+        upload: "maze_output/passed/**/*"
+      docker-compose#v4.7.0:
+        pull: maze-runner
+        run: maze-runner
+        service-ports: true
+        command:
+          - "--app=/app/features/fixtures/mazerunner/build/ios/ipa/mazerunner.ipa"
+          - "--farm=bb"
+          - "--device=IOS_14|IOS_15|IOS_16"
+          - "--no-tunnel"
+          - "--aws-public-ip"
+          - "--fail-fast"
+    concurrency: 25
+    concurrency_group: 'bitbar'
+    concurrency_method: eager
+
+
+  #
+  # Android
+  #
+  - label: Build Android Test Fixture
+    key: "android-fixture-3-10-0"
+    timeout_in_minutes: 20
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+      JAVA_VERSION: "11"
+    commands:
+      - bundle install
+      - features/scripts/generate_fixture.sh
+      - features/scripts/build_android_app.sh
+    plugins:
+      artifacts#v1.5.0:
+        upload:
+          - "features/fixtures/mazerunner/build/app/outputs/flutter-apk/app-release.apk"
+
+  - label: ':bitbar: Android 12 end-to-end tests 3.10.0'
+    depends_on: "android-fixture-3-10-0"
+    timeout_in_minutes: 20
+    env:
+      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
+    agents:
+      queue: opensource
+    plugins:
+      artifacts#v1.5.0:
+        download: "features/fixtures/mazerunner/build/app/outputs/flutter-apk/app-release.apk"
+        upload: "maze_output/failed/**/*"
+        upload: "maze_output/passed/**/*"
+      docker-compose#v4.7.0:
+        pull: maze-runner
+        run: maze-runner
+        service-ports: true
+        command:
+          - "--app=features/fixtures/mazerunner/build/app/outputs/flutter-apk/app-release.apk"
+          - "--farm=bb"
+          - "--device=ANDROID_10|ANDROID_11|ANDROID_12|ANDROID_13"
+          - "--no-tunnel"
+          - "--aws-public-ip"
+          - "--fail-fast"
+    concurrency: 25
+    concurrency_group: 'bitbar'
+    concurrency_method: eager

.github/ISSUE_TEMPLATE/A.md

@@ -0,0 +1,14 @@
+---
+name: Having trouble getting started?
+about: Please contact us at [email protected] for assistance with integrating Bugsnag
+  into your application.
+title: ''
+labels: ''
+assignees: ''
+
+---
+Please checkout our [documentation](https://docs.bugsnag.com/performance/flutter/) for guides, references and tutorials.
+
+If you have questions about your integration please contact us at [[email protected]](mailto:[email protected]).
+
+Alternatively, view additional options at [support.md](../SUPPORT.md).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,55 @@
+---
+name: Bug report
+about: Create a report to help us improve the library
+title: ""
+labels: ""
+assignees: ""
+---
+
+<!-- Before raising, please check if somebody else has already reported your issue. -->
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Environment
+
+- BugSnag Performance version:
+- BugSnag version (if any):
+- Flutter version:
+- Flutter-first app or native app with Flutter component(s):
+- iOS/Android version:
+- Simulator/emulator or physical device:
+
+<!--
+  Below are a few approaches you might take to communicate the issue, in
+  descending order of awesomeness. Please choose one and feel free to delete
+  the others from this template.
+-->
+
+### Example Repo <!-- Option 1 -->
+
+- [ ] Create a minimal repository that can reproduce the issue
+- [ ] Link to it here:
+
+### Example code snippet <!-- Option 2 -->
+
+```
+# (Insert code sample to reproduce the problem)
+```
+
+<!-- Error messages, if any -->
+<details><summary>Error messages:</summary>
+
+```
+
+```
+
+</details>

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Before creating, please check if somebody else has already reported your feature request. -->
+
+### Description
+<!-- Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+-->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!--Add any other context about the feature request here.-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Goal
+
+<!-- Why is this change necessary? -->
+
+## Design
+
+<!-- Why was this approach used? -->
+
+## Changeset
+
+<!-- What changed? -->
+
+## Testing
+
+<!-- How was it tested? What manual and automated tests were
+     run/added? -->

.github/support.md

@@ -0,0 +1,27 @@
+## Are you having trouble getting started?
+
+If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/performance/flutter/) for guides, references and tutorials.
+
+Or, if you wish you can [contact us directly](mailto:[email protected]) for assistance on integrating BugSnag into your application, troubleshooting an issue or a question about our supported features.
+
+When contacting support, please include as much information as necessary, including:
+
+- example code snippet
+- steps to reproduce
+- expected/actual behaviour
+
+- BugSnag Performance version:
+- BugSnag version (if any):
+- Flutter version:
+- Flutter-first app or native app with Flutter component(s):
+- iOS/Android version:
+- Simulator/emulator or physical device:
+
+## Bug or Feature Requests
+
+If you would like to raise a bug or feature request please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-flutter-performance/issues/new/choose) and selecting bug or feature.
+Please note: we cannot promise that we will fulfil all requests
+
+## Pull Requests
+
+If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../CONTRIBUTING.md) file before creating the pull request.

.gitignore

@@ -25,3 +25,11 @@ doc/api/
 
 .flutter-plugins
 .flutter-plugins-dependencies
+
+Package.resolved
+Podfile.lock
+maze_output/
+
+# ignored as fixtures are generated
+features/fixtures
+bb.ready

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "packages/bugsnag-flutter-http-client"]
+	path = packages/bugsnag-flutter-http-client
+	url = [email protected]:bugsnag/bugsnag-flutter-http-client.git
+[submodule "packages/bugsnag-flutter-dart-io-http-client"]
+	path = packages/bugsnag-flutter-dart-io-http-client
+	url = [email protected]:bugsnag/bugsnag-flutter-dart-io-http-client.git

CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+## 1.0.0 (2024-04-11)
+
+Initial release

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+Contributing
+============
+
+- [Fork](https://help.github.com/articles/fork-a-repo)
+  the [notifier on github](https://github.com/bugsnag/bugsnag-flutter-performance)
+- Build and test your changes
+- Commit and push until you are happy with your contribution
+- [Make a pull request](https://help.github.com/articles/using-pull-requests)
+- Thanks!
+
+## Reporting issues
+
+Are you having trouble getting started?
+Please [contact us directly](mailto:[email protected]?subject=%5BGitHub%5D%20Flutter%20Performance%20SDK%20-%20having%20trouble%20getting%20started%20with%20Bugsnag)
+for assistance with integrating Bugsnag into your application. If you have spotted a problem with
+this module, feel free to open a [new issue](https://github.com/bugsnag/bugsnag-flutter-performance/issues/new).
+Here are a few things to check before doing so:
+
+* Are you using the latest version of `bugsnag-flutter-performance`? If not, does updating to the latest version
+  fix your issue?
+* Has somebody
+  else [already reported](https://github.com/bugsnag/bugsnag-flutter-performance/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen)
+  your issue? Feel free to add additional context to or check-in on an existing issue that matches
+  your own.
+* Is your issue caused by this module? Only things related to the `bugsnag-flutter-performance` module should be
+  reported here. For anything else, please [contact us directly](mailto:[email protected]) and
+  we'd be happy to help you out.
+
+### Fixing issues
+
+If you've identified a fix to a new or existing issue, we welcome contributions!
+Here are some helpful suggestions on contributing that help us merge your PR quickly and smoothly:
+
+* [Fork](https://help.github.com/articles/fork-a-repo) the
+  [library on GitHub](https://github.com/bugsnag/bugsnag-flutter-performance)
+* Build and test your changes using the example app and test suite
+* Commit and push until you are happy with your contribution
+* [Make a pull request](https://help.github.com/articles/using-pull-requests)
+* Ensure the automated checks pass (and if it fails, please try to address the cause)
+
+### Adding features
+
+Unfortunately we’re unable to accept PRs that add features or refactor the library at this time.
+However, we’re very eager and welcome to hearing feedback about the library so please contact us
+directly to discuss your idea, or open a
+[feature request](https://github.com/bugsnag/bugsnag-flutter-performance/issues/new?template=Feature_request.md)
+to help us improve the library.
+
+Here’s a bit about our process designing and building the Bugsnag libraries:
+
+* We have an internal roadmap to plan out the features we build, and sometimes we will already be
+  planning your suggested feature!
+* Our open source libraries span many languages and frameworks so we strive to ensure they are
+  idiomatic on the given platform, but also consistent in terminology between platforms. That way
+  the core concepts are familiar whether you adopt Bugsnag for one platform or many.
+* Finally, one of our goals is to ensure our libraries work reliably, even in crashy, multi-threaded
+  environments. Oftentimes, this requires an intensive engineering design and code review process
+  that adheres to our style and linting guidelines.
+
+### Making a Release
+
+- Using GitHub create a new releasing branch from `next`: `releases/v<version number>`
+- Checkout the release branch
+  - Bump the version number: `make VERSION=<version> bump`
+  - Inspect the updated CHANGELOG, README, and version files to ensure they are correct
+  - Open a PR from the release branch to `main`
+- Once merged:
+  - Pull the latest changes from `main`
+  - Run `git clean -df` to ensure no unexpected files make it into the release
+  - Creating the staged release: `make stage`
+  - Publish the new version to pub.dev: 
+    - `cd staging/bugsnag_flutter_performance && flutter pub publish`
+- Release on GitHub:
+  - Create a release and tag from `main`
+    on [GitHub Releases](https://github.com/bugsnag/bugsnag-flutter-performance/releases)
+- Merge outstanding docs PRs related to this release 
+- Merge main into next
+
+## Further development docs
+
+For information on how to build the library and develop changes you should start by
+reading [the docs](docs/RELEASING.md).
+
+
+

Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'cocoapods'
+
+# A reference to Maze Runner is only needed for running tests locally and if committed it must be
+# portable for CI, e.g. a specific release.  However, leaving it commented out would mean quicker CI.
+gem 'bugsnag-maze-runner', '~> 8.13.2'
+
+# Use a specific branch
+#gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner', branch: 'master'
+
+# Locally, you can run against Maze Runner branches and uncommitted changes:
+#gem 'bugsnag-maze-runner', path: '../maze-runner'