Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
f93937d
:boom: Add .metadata file to track Flutter project properties
IamPekka058 Apr 9, 2025
bf5cc4c
:fire: Remove 'integration_test' from .pubignore
IamPekka058 Apr 9, 2025
3a61e87
:fire: Remove example
IamPekka058 Apr 9, 2025
2abcc8b
:recycle: Move models to new directory
IamPekka058 Apr 9, 2025
0a64c79
:recycle: Move services to new directory
IamPekka058 Apr 9, 2025
f9fd206
:recycle: Remove 'package_api_docs' from analysis options
IamPekka058 Apr 9, 2025
1da50cd
:recycle: Update references from 'GitHub.dart' to 'github_flutter' in…
IamPekka058 Apr 9, 2025
2f3beeb
:fire: Remove files
IamPekka058 Apr 9, 2025
28446a6
:recycle: Refactor tests
IamPekka058 Apr 9, 2025
0726fd4
:bookmark: Update CHANGELOG.md for initial release of github_flutter
IamPekka058 Apr 9, 2025
ac8b33e
:recycle: Update imports to use 'github_flutter' and clean up code fo…
IamPekka058 Apr 9, 2025
c12453e
:memo: Update first draft of README.md
IamPekka058 Apr 9, 2025
728ddf2
:recycle: Update pubspec.yaml for github_flutter package, including v…
IamPekka058 Apr 9, 2025
36c312b
:recycle: Update CI configuration for Dart & Flutter, enhancing analy…
IamPekka058 Apr 9, 2025
42f61a1
:sparkles: Add generated JSON serialization for repository-related mo…
IamPekka058 Apr 9, 2025
0465fdc
:memo: Revise README.md to clarify project origin and streamline cont…
IamPekka058 Apr 9, 2025
c033798
:fire: Remove unused files: create_release.yml, create_tag.yml, langu…
IamPekka058 Apr 9, 2025
55c93ca
:fire: Remove unused exports from common.dart
IamPekka058 Apr 9, 2025
70f6a91
:construction_worker: Add GitHub Actions workflow for generating and …
IamPekka058 Apr 9, 2025
c9c5a98
:recycle: Update pubspec.yaml to include Flutter SDK dependency and s…
IamPekka058 Apr 9, 2025
34429c7
:construction_worker: Add workflow_dispatch trigger to docs.yml for m…
IamPekka058 Apr 9, 2025
2775302
:construction_worker: Temporary testing hook
IamPekka058 Apr 9, 2025
15afc33
:construction_worker: Temporary testing hook
IamPekka058 Apr 9, 2025
3003703
:recycle: Update GitHub Actions workflow to use Flutter for setup and…
IamPekka058 Apr 9, 2025
3ea3afb
:recycle: Remove push trigger from docs.yml and retain workflow_dispa…
IamPekka058 Apr 9, 2025
97c6e29
📝 Added Status Badge
IamPekka058 Apr 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .github/workflows/create_release.yml

This file was deleted.

25 changes: 0 additions & 25 deletions .github/workflows/create_tag.yml

This file was deleted.

42 changes: 19 additions & 23 deletions .github/workflows/dart.yml
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
name: Dart Checks
name: Dart & Flutter CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
# Test with at least the declared minimum Dart version
sdk: ['3.0', stable]
analyze:
name: Dart & Flutter CI
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: dart-lang/setup-dart@v1

- uses: subosito/flutter-action@v2
with:
sdk: ${{ matrix.sdk }}
channel: stable
cache: true

- name: Install dependencies
run: dart pub get
- name: Dart Analyzer
run: dart analyze
- name: Check Dart Format
if: ${{ matrix.sdk == 'stable' }}
run: dart format --set-exit-if-changed -onone .
- name: Unit tests
run: dart test
- name: Check if Publishable
run: dart pub publish --dry-run
run: flutter pub get

- name: Format check
run: dart format --set-exit-if-changed .

- name: Analyze
run: flutter analyze

- name: Run tests
run: flutter test
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Generate and Deploy Docs

on:
workflow_dispatch:

jobs:
generate-and-deploy-docs:
runs-on: ubuntu-latest

steps:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v4

# Install Flutter
- uses: subosito/flutter-action@v2
with:
channel: stable
cache: true

# Install dependencies
- name: Install dependencies
run: flutter pub get

# Generate documentation
- name: Generate documentation
run: dart doc .

# Deploy to GitHub Pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/api
30 changes: 0 additions & 30 deletions .github/workflows/publish_demos.yml

This file was deleted.

33 changes: 0 additions & 33 deletions .github/workflows/triage.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.

version:
revision: "c23637390482d4cf9598c3ce3f2be31aa7332daf"
channel: "stable"

project_type: package
3 changes: 1 addition & 2 deletions .pubignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
tool
test
integration_test
test
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.0.1
- Initial release of the github_flutter Dart library.

## ----------------Switch from github to github_flutter----------------
## 9.24.0

* Bug fixes to the `Issue.isOpen` and `Issue.isClosed` getters.
Expand Down
34 changes: 6 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Contributing Guide

GitHub.dart is of course Open Source! We love it when people contribute!
github_flutter is of course Open Source! We love it when people contribute!

## Getting Started

- Make sure you have a [GitHub Account](https://github.com/signup/free).
- Make sure the [Dart SDK](https://dart.dev/tools/sdk) is installed on your system.
- Make sure you have [Git](http://git-scm.com/) installed on your system.
- [Fork](https://help.github.com/articles/fork-a-repo) the [repository](https://github.com/SpinlockLabs/github.dart) on GitHub.
- [Fork](https://help.github.com/articles/fork-a-repo) the [repository](https://github.com/IamPekka058/github_flutter) on GitHub.

## Making Changes

- [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository) for your changes.
- [Commit your code](http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository) for each logical change (see [tips for creating better commit messages](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)).
- [Push your change](https://help.github.com/articles/pushing-to-a-remote) to your fork.
- [Create a Pull Request](https://help.github.com/articles/creating-a-pull-request) on GitHub for your change.
- Wait for reviewers (usually robrbecker) to give feedback.
- Wait for reviewers to give feedback.
- When the reviewers think that the Pull Request is ready, they will merge it.

## Code Style

GitHub.dart follows the [Dart Style Guide](https://dart.dev/effective-dart/style). Please note that if your code is not formatted according to the guide as much as possible, we will reject your Pull Request until it is fixed. Some things such as long lines will generally be accepted, however try to make it smaller if possible.
github_flutter follows the [Dart Style Guide](https://dart.dev/effective-dart/style). Please note that if your code is not formatted according to the guide as much as possible, we will reject your Pull Request until it is fixed. Some things such as long lines will generally be accepted, however try to make it smaller if possible.

## Efficiency

GitHub.dart is committed to efficiency as much as possible. If your code is not efficient, then we will probably reject your Pull Request.
github_flutter is committed to efficiency as much as possible. If your code is not efficient, then we will probably reject your Pull Request.

## Rejections

Expand All @@ -40,26 +40,4 @@ dart run build_runner build -d

## Tests

`dart test` will only run the unit tests.

To run the complete test suite you will need to install
`octokit/fixtures-server`.

```
npm install --global @octokit/fixtures-server
```

Tests can be run using `make test`, which will start up a local mock
GitHub and execute tests against it using your localhost port 3000.

## Contacting Us

File issues at https://github.com/SpinlockLabs/github.dart/issues

## Releases

Merged pull requests that edit the `pubspec.yaml` version will create new releases.
Once CI is green, it will create a tag for that commit based on the version, which
gets published by pub.dev.

If no new version was created, nothing will be published.
`dart test` will only run the unit tests.
20 changes: 0 additions & 20 deletions Makefile

This file was deleted.

36 changes: 11 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,24 @@
# GitHub for Dart
# github_flutter
[![Dart & Flutter CI](https://github.com/IamPekka058/github_flutter/actions/workflows/dart.yml/badge.svg?branch=main)](https://github.com/IamPekka058/github_flutter/actions/workflows/dart.yml)

[![Dart Checks](https://github.com/SpinlockLabs/github.dart/actions/workflows/dart.yml/badge.svg)](https://github.com/SpinlockLabs/github.dart/actions/workflows/dart.yml)
[![Pub](https://img.shields.io/pub/v/github.svg)](https://pub.dev/packages/github)

This is a library for interacting with GitHub in Dart. It works on all platforms including web, server, and Flutter.
This is a lightweight library based on ![Github.dart](https://github.com/SpinlockLabs/github.dart/) for interacting with GitHub in Dart. It works on following platforms:
| Platform | Supported |
|-----------------|-------------|
| Mobile (Native) | ✅ |
| Browser | ✅ |
| Desktop | ✅ |

Please submit issues and pull requests, help out, or just give encouragement.

**Notice**: This is not an official GitHub project. It is maintained by volunteers.
We are looking for contributors. If you're interested or have questions, head over to discussions https://github.com/SpinlockLabs/github.dart/discussions
We are looking for contributors.

## Features

- Works on the Server, Browser, and Flutter
- Works on Desktop, Mobile, Browser
- Really Fast
- Pluggable API
- Supports Authentication
- Builtin OAuth2 Flow
- Hook Server Helper

## Links

- [Library Demos](https://spinlocklabs.github.io/github.dart/) (based on the [sample code](https://github.com/SpinlockLabs/github.dart/tree/master/example))
- [Pub Package](https://pub.dev/packages/github)
- [Wiki](https://github.com/SpinlockLabs/github.dart/wiki)
- [Latest API reference](https://pub.dev/documentation/github/latest/)

## Examples

See the examples in the example directory to learn how to use some of the features!

## Contacting Us

Post a question or idea: https://github.com/SpinlockLabs/github.dart/discussions

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SpinlockLabs/github.dart&type=Date)](https://star-history.com/#SpinlockLabs/github.dart&Date)
1 change: 0 additions & 1 deletion analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ linter:
- omit_local_variable_types
- one_member_abstracts
- only_throw_errors
- package_api_docs
- prefer_asserts_in_initializer_lists
- prefer_const_constructors
- prefer_const_constructors_in_immutables
Expand Down
15 changes: 0 additions & 15 deletions dart_test.yaml

This file was deleted.

Loading