aboutsummaryrefslogtreecommitdiff
path: root/mod/mod-ci-github-gq.hxx
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2024-06-07 10:17:30 +0200
committerFrancois Kritzinger <francois@codesynthesis.com>2024-12-10 16:34:15 +0200
commit24415b406a6457638fc4e5435bab9fed987d01ba (patch)
tree6c97d7d4696d515000037341c4c5deff1224e498 /mod/mod-ci-github-gq.hxx
parent8ef7e9ca2dc95d1f1b49c032c6ca0355ab88e519 (diff)
Plan and prepare for upcoming restructuring
Diffstat (limited to 'mod/mod-ci-github-gq.hxx')
-rw-r--r--mod/mod-ci-github-gq.hxx21
1 files changed, 2 insertions, 19 deletions
diff --git a/mod/mod-ci-github-gq.hxx b/mod/mod-ci-github-gq.hxx
index 439f7b7..ad9797a 100644
--- a/mod/mod-ci-github-gq.hxx
+++ b/mod/mod-ci-github-gq.hxx
@@ -83,24 +83,6 @@ namespace brep
build_state,
optional<gq_built_result> = nullopt);
- // Fetch a pull request's mergeability from GitHub and return it in first,
- // or absent if the merge commit is still being generated.
- //
- // Return false in second and issue diagnostics if the request failed.
- //
- struct gq_pr_mergeability
- {
- // True if the pull request is auto-mergeable; false if it would create
- // conflicts.
- //
- bool mergeable;
-
- // The ID of the test merge commit. Empty if mergeable is false.
- //
- string merge_commit_id;
- };
-
-
// Fetch a pull request's mergeability from GitHub. Return absent value if
// the merge commit is still being generated. Return empty string if the
// pull request is not auto-mergeable. Otherwise return the test merge
@@ -110,7 +92,8 @@ namespace brep
// will be treated by the caller as still being generated).
//
// Note that the first request causes GitHub to start preparing the test
- // merge commit.
+ // merge commit. (For details see
+ // https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests.)
//
optional<string>
gq_pull_request_mergeable (const basic_mark& error,