pub struct GitHubPrProvider<R: CommandRunner = RealCommandRunner> { /* private fields */ }Expand description
GitHub Pull Request 提供者,通过 gh CLI 操作。
该结构体通过调用 gh CLI 实现 PrProvider trait 的所有方法,
使上层命令能够以统一的方式操作 GitHub Pull Request。
命令执行通过 CommandRunner 抽象,生产环境默认使用
RealCommandRunner,测试可注入自定义 runner 以模拟成功或失败场景。
§Examples
use gitflow_github::GitHubPrProvider;
let provider = GitHubPrProvider::new("octocat/hello-world");Implementations§
Source§impl<R: CommandRunner> GitHubPrProvider<R>
impl<R: CommandRunner> GitHubPrProvider<R>
Sourcepub fn with_runner(repo: impl Into<String>, runner: R) -> Self
pub fn with_runner(repo: impl Into<String>, runner: R) -> Self
使用自定义 CommandRunner 创建提供者。
主要用于测试,可注入模拟 runner 以控制 gh CLI 的输出。
repo 格式为 owner/repo。
Trait Implementations§
Source§impl<R: Clone + CommandRunner> Clone for GitHubPrProvider<R>
impl<R: Clone + CommandRunner> Clone for GitHubPrProvider<R>
Source§impl<R: Debug + CommandRunner> Debug for GitHubPrProvider<R>
impl<R: Debug + CommandRunner> Debug for GitHubPrProvider<R>
Source§impl<R: CommandRunner + Clone + 'static> PrProvider for GitHubPrProvider<R>
impl<R: CommandRunner + Clone + 'static> PrProvider for GitHubPrProvider<R>
Source§fn close<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn close<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
关闭指定编号的 PR。
调用 gh pr close <number> --repo <repo> 关闭 PR,
并返回更新后的完整 PR 数据。
§Errors
当 PR 不存在、已关闭或 gh CLI 调用失败时返回错误。
Source§fn reopen<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn reopen<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
重新打开指定编号的 PR。
调用 gh pr reopen <number> --repo <repo> 重新打开已关闭的 PR,
并返回更新后的完整 PR 数据。
§Errors
当 PR 不存在、未关闭或 gh CLI 调用失败时返回错误。
Source§fn comment<'life0, 'life1, 'async_trait>(
&'life0 self,
number: u64,
body: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<CommentData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn comment<'life0, 'life1, 'async_trait>(
&'life0 self,
number: u64,
body: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<CommentData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
在指定 PR 上添加评论。
调用 gh api repos/{repo}/issues/{number}/comments -X POST 创建评论,
直接从 POST 响应中解析新创建的评论数据。
(PR 评论使用与 Issue 评论相同的 API 端点。)
§Errors
当 PR 不存在、body 为空或 gh CLI 调用失败时返回错误。
Source§fn merge<'life0, 'async_trait>(
&'life0 self,
number: u64,
strategy: Option<MergeStrategy>,
auto: bool,
) -> Pin<Box<dyn Future<Output = Result<MergeResult>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn merge<'life0, 'async_trait>(
&'life0 self,
number: u64,
strategy: Option<MergeStrategy>,
auto: bool,
) -> Pin<Box<dyn Future<Output = Result<MergeResult>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
合并指定编号的 PR。
调用 gh pr merge <number> --repo <repo> 并根据 strategy 参数
添加 --squash、--rebase 或 --merge 标志。
未指定策略时使用 --merge(标准合并)。
auto 为 true 时追加 --auto,由 GitHub 在必需检查通过后自动合并,
调用立即返回;此时 merged 为 false(排队不等于已合并)。
§Errors
当 PR 不存在、存在冲突无法合并或 gh CLI 调用失败时返回错误。
Source§fn checkout<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn checkout<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
在本地检出指定 PR 的分支。
调用 gh pr checkout <number> --repo <repo> 在本地工作区创建并切换到
PR 的来源分支。如果本地已存在该分支,则尝试更新它。
§Errors
当 PR 不存在、本地 git 操作失败或 gh CLI 调用失败时返回错误。
Source§fn mark_ready<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn mark_ready<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
将草稿 PR 标记为可审查状态(ready for review)。
调用 gh pr ready <number> --repo <repo> 将草稿 PR 转为可审查状态,
并通过 gh pr view 重新获取更新后的 PR 数据。
§Errors
当 PR 不存在、不是草稿状态或 gh CLI 调用失败时返回错误。
Source§fn mark_wip<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn mark_wip<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
将 PR 标记为草稿状态(work in progress)。
调用 gh pr convert-to-draft <number> --repo <repo> 将可审查的 PR 转为草稿,
并通过 gh pr view 重新获取更新后的 PR 数据。
§Errors
当 PR 不存在、已是草稿状态或 gh CLI 调用失败时返回错误。
Source§fn sync_branch<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn sync_branch<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
同步 PR 的分支(将 base 分支的最新变更合入 head 分支)。
调用 gh pr update-branch <number> --repo <repo> 将 PR 的来源分支
更新到与目标分支的最新状态同步,解决分支过时问题。
§Errors
当 PR 不存在、同步存在冲突或 gh CLI 调用失败时返回错误。
Source§fn diff<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn diff<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
获取指定 PR 的统一差异格式(unified diff)文本。
调用 gh pr diff <number> --repo <repo> 获取平台原生的 unified diff
输出,可直接用于 git apply。
§Errors
当 PR 不存在或 gh CLI 调用失败时返回错误。
Source§fn patch<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn patch<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
获取指定 PR 的 patch 格式文本(含邮件头信息)。
调用 gh api repos/{repo}/pulls/{number} 并设置 Accept 头为
application/vnd.github.v3.patch,返回包含 commit 元数据的 patch 格式输出,
可用于 git am。
§Errors
当 PR 不存在或 gh CLI 调用失败时返回错误。
Source§fn default_branch<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn default_branch<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
查询仓库配置的默认分支(如 main、dev)。
调用 gh repo view --json defaultBranchRef 并解析 name 字段。
§Errors
当 gh CLI 调用失败或响应无法解析时返回错误。
Source§fn create<'life0, 'async_trait>(
&'life0 self,
args: CreatePrArgs,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn create<'life0, 'async_trait>(
&'life0 self,
args: CreatePrArgs,
) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Auto Trait Implementations§
impl<R> Freeze for GitHubPrProvider<R>where
R: Freeze,
impl<R> RefUnwindSafe for GitHubPrProvider<R>where
R: RefUnwindSafe,
impl<R> Send for GitHubPrProvider<R>
impl<R> Sync for GitHubPrProvider<R>
impl<R> Unpin for GitHubPrProvider<R>where
R: Unpin,
impl<R> UnsafeUnpin for GitHubPrProvider<R>where
R: UnsafeUnpin,
impl<R> UnwindSafe for GitHubPrProvider<R>where
R: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more