https://github.com/bixat/github_snitch
Flutter package for open github issue for crashes, issues & proposals
https://github.com/bixat/github_snitch
dart flutter github reporter
Last synced: 2 months ago
JSON representation
Flutter package for open github issue for crashes, issues & proposals
- Host: GitHub
- URL: https://github.com/bixat/github_snitch
- Owner: bixat
- License: mit
- Created: 2022-10-13T20:10:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T08:40:18.000Z (over 1 year ago)
- Last Synced: 2025-07-29T01:14:37.983Z (2 months ago)
- Topics: dart, flutter, github, reporter
- Language: Dart
- Homepage: https://pub.dev/packages/github_snitch
- Size: 374 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Snitch
GitHub Snitch is a Flutter package that helps you report bugs and issues on GitHub automatically. It can also be used to submit comments on existing issues.
demo for testing : https://gh-snitch.web.app
## Features
- Report bugs on GitHub issues with specific labels, assignees, and milestones
- Automatically when calling the `listenToExceptions` method in `main` as shown in the example
- Manually with the `report` method
- Support offline cases (save locally and send later when a connection exists)
- Get reported issues with all comments
- Submit comments from the user and reply from GitHub issues by repository owners
- Include screenshots in the report for better issue clarification.
- Handled duplicated reports by added comment (+1) for duplicate issues
- Use onReport method for handle api integrations
- Create follow labels for package
- GhSnitch-external for Errors not caught by Flutter Framework
- GhSnitch-internal for Errors caught by Flutter Framework
- Reported by GhSnitch Package for knowing which issues are reported from this package
## Upcoming features
- Support notifications for chat with user and repository owners
## Tips
> [!TIP]
> Is preferable to use empty repo for reporting issues & bugs then transfer important items to main repo
> [!TIP]
> For send screenshot to user from issue comment use some website for upload image and add link to comment, don't use screenshot from github repo because it will not work
> [!TIP]
> You can use ready screens by call `GhSnitch.openReportScreen(context);` or build ypu screens and use methods like `GhSnitch.report` & `GhSnitch.submitComment` to submit issues & comments
> [!TIP]
> Create branch for upload screenshots with name `screenshots` or any name you want but you need to pass this name to `screenShotBranch` parameter in `GhSnitch.report` method if you used `GhSnitch.openReportScreen(context);` you should use `screenshots` name
## Getting Started
After install package you need to generate [fine-grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) choose fine-grained personal access token & select your repo & from Repository permissions check Issues
Access: Read and write.
We need also `owner username` & `repo name`
We will use Environment variables for save this sensive keys
## Usage
For run or build app just pass --dart-define for every key as example :
```
flutter build apk --split-per-abi --dart-define owner=owner --dart-define repo=repo --dart-define token=token
```
Then Add this code before runApp method
As you see we used keys from Environment
```dart
WidgetsFlutterBinding.ensureInitialized();
const String owner = String.fromEnvironment('owner');
String appFlavor = 'x';
String appVersion = '2.0.0';
GhSnitch.initialize(
owner: owner,
token: const String.fromEnvironment('token'),
repo: const String.fromEnvironment("repo"));
if (kReleaseMode) {
// For report exceptions & bugs Automaticlly
GhSnitch.listenToExceptions(assignees: [owner], labels: [appFlavor, appVersion]);
}
runApp(const MyApp());
```
Now that GitHub Snitch is initialized, you can start reporting bugs and issues. To do this, you can call the `report` method:
```dart
GhSnitch.report(
title: '',
body: '',
screenShot: '',
screenShotBranch: '',
labels: ?>,
assignees: ?>,
milestone: ' if null will create new milestone with app version name',
userId: '',
);
```
The `report` method takes the following parameters:
* `title`: The title of the issue.
* `body`: The body of the issue.
* `screenShot`: The URL of the screenshot.
* `screenShotBranch`: parameter specifies the branch of the repository where the screenshot will be saved.
* `labels`: A list of labels for the issue.
* `assignees`: A list of users to assign the issue to.
* `milestone`: The milestone to associate the issue with.
## Listening to Exceptions
GitHub Snitch can also be used to listen to exceptions and bugs. To do this, you can call the `listenToExceptions` method:
```
GhSnitch.listenToExceptions(
assignees: ?>,
milestone: ,
);
```
The `listenToExceptions` method takes the following parameters:
* `assignees`: A list of users to assign the issue to.
* `milestone`: The milestone to associate the issue with.
When an exception or bug is detected, GitHub Snitch will automatically create an issue on GitHub.
## Submitting Comments
GitHub Snitch can also be used to submit comments on existing issues. To do this, you can call the `submitComment` method:
```dart
GhSnitch.submitComment(
reportId: '',
comment: '',
);
```
The `submitComment` method takes the following parameters:
* `reportId`: The ID of the issue.
* `comment`: The text of the comment.
## Conclusion
GitHub Snitch is a powerful tool that can help you keep track of bugs and issues on GitHub. It can also be used to submit comments on existing issues. If you're looking for a way to improve your GitHub workflow, I highly recommend checking out GitHub Snitch.
Feel free to contribute to this package by opening issues or submitting pull requests on [GitHub ↗](https://github.com/M97Chahboun/github_snitch).