Add support for creating draft PRs

aaronlademann-wf · aaronlademann-wf · commit af73df4009fc · 2020-03-05T09:32:24.000-07:00
diff --git a/lib/src/common/model/pulls.dart b/lib/src/common/model/pulls.dart
@@ -1,6 +1,7 @@
 import 'package:github/src/common.dart';
 import 'package:github/src/common/model/users.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 
 part 'pulls.g.dart';
 
@@ -159,11 +160,20 @@ class PullRequestHead {
 /// Model class for a pull request to be created.
 @JsonSerializable(fieldRename: FieldRename.snake)
 class CreatePullRequest {
-  CreatePullRequest(this.title, this.head, this.base, {this.body});
+  CreatePullRequest(this.title, this.head, this.base,
+      {this.draft = false, this.body});
 
   final String title;
   final String head;
   final String base;
+
+  /// Whether a draft PR should be created.
+  ///
+  /// This is currently experimental functionality since the way draft PRs are
+  /// created through Github's REST API is in developer preview only - and could change at any time.
+  @experimental
+  final bool draft;
+
   String body;
 
   factory CreatePullRequest.fromJson(Map<String, dynamic> input) =>
diff --git a/lib/src/common/model/pulls.g.dart b/lib/src/common/model/pulls.g.dart
diff --git a/lib/src/common/pulls_service.dart b/lib/src/common/pulls_service.dart
@@ -49,8 +49,14 @@ class PullRequestsService extends Service {
   ///
   /// API docs: https://developer.github.com/v3/pulls/#create-a-pull-request
   Future<PullRequest> create(RepositorySlug slug, CreatePullRequest request) {
-    return github.postJSON('/repos/${slug.fullName}/pulls',
-        convert: (i) => PullRequest.fromJson(i), body: jsonEncode(request));
+    return github.postJSON(
+      '/repos/${slug.fullName}/pulls',
+      convert: (i) => PullRequest.fromJson(i),
+      body: jsonEncode(request),
+      preview: request.draft
+          ? 'application/vnd.github.shadow-cat-preview+json'
+          : null,
+    );
   }
 
   /// Edit a pull request.
