Skip to main content

GitHubIssueProvider

Struct GitHubIssueProvider 

Source
pub struct GitHubIssueProvider<R: CommandRunner = RealCommandRunner> { /* private fields */ }
Expand description

GitHub Issue 提供者,通过 gh CLI 操作。

该结构体通过调用 gh CLI 实现 IssueProvider trait 的所有方法, 使上层命令能够以统一的方式操作 GitHub Issue。

命令执行通过 CommandRunner 抽象,生产环境默认使用 RealCommandRunner,测试可注入自定义 runner 以模拟成功或失败场景。

§Examples

use gitflow_github::GitHubIssueProvider;

let provider = GitHubIssueProvider::new("octocat/hello-world");

Implementations§

Source§

impl GitHubIssueProvider<RealCommandRunner>

Source

pub fn new(repo: impl Into<String>) -> Self

创建新的 GitHub Issue 提供者,使用真实的进程执行器。

repo 格式为 owner/repo。

Source

pub fn with_session(session: &Session) -> Self

Create a new provider from a shared [Session].

This enables state reuse across multiple operations in workflow chains.

Source§

impl<R: CommandRunner> GitHubIssueProvider<R>

Source

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 GitHubIssueProvider<R>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<R: Debug + CommandRunner> Debug for GitHubIssueProvider<R>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<R: CommandRunner + Clone + 'static> IssueProvider for GitHubIssueProvider<R>

Source§

fn edit<'life0, 'async_trait>( &'life0 self, number: u64, args: EditIssueArgs, ) -> Pin<Box<dyn Future<Output = Result<IssueData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

编辑 Issue 的标题和/或正文。

调用 gh issue edit <number> --repo <repo> [--title T] [--body B], 成功后通过 view 重新拉取最新数据并返回。

§Errors

当 Issue 不存在或 gh CLI 调用失败时返回错误。

Source§

fn close<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<IssueData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

关闭指定编号的 Issue。

通过单次 gh api repos/{owner}/{repo}/issues/{number} -X PATCH -f state=closed 调用更新状态,并直接解析 REST 响应获得更新后的完整 Issue 数据。 该调用幂等:对已关闭的 Issue 再次关闭将成功返回其当前数据。

§设计说明(issue #117)

早期实现先调用 gh issue close,再用 gh issue view --json 重新获取详情。 该双调用设计有两个缺陷:

  1. --json 输出来自 gh 的 GraphQL 导出层,字段形状随 gh 版本漂移 (如 gh 2.94+ 的 bot author 省略 id),导致反序列化失败;
  2. 关闭操作已经成功时,二次获取的解析失败仍被误报为“关闭失败“。

改为单次 REST 调用后,变更与数据在同一响应中返回,两个缺陷同时消除。 REST 响应形状是 GitHub API 的稳定契约,bot 用户同样携带数字 id。

§Errors

当 Issue 不存在、gh CLI 调用失败或响应解析失败时返回错误。

Source§

fn reopen<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<IssueData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

重新打开指定编号的 Issue。

通过单次 gh api repos/{owner}/{repo}/issues/{number} -X PATCH -f state=open 调用更新状态,并直接解析 REST 响应获得更新后的完整 Issue 数据。 该调用幂等:对未关闭的 Issue 再次打开将成功返回其当前数据。

§设计说明(issue #117)

与 close 相同,改为单次 REST 调用以消除双调用的 反序列化漂移与误报失败问题。

§Errors

当 Issue 不存在、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,

在指定 Issue 上添加评论。

调用 gh api repos/{repo}/issues/{number}/comments -X POST 创建评论, 直接从 POST 响应中解析新创建的评论数据。

§Errors

当 Issue 不存在、body 为空或 gh CLI 调用失败时返回错误。

Source§

fn list_comments<'life0, 'async_trait>( &'life0 self, number: u64, limit: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<Paged<CommentData>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

列出指定 Issue 的评论。

调用 gh api repos/{repo}/issues/{number}/comments 获取评论列表, 通过 per_page/page 查询参数逐页取到 limit(已实测 gh api 直接接受这两个查询参数,无需 --paginate)。

§Errors

当 Issue 不存在或 gh CLI 调用失败时返回错误。

Source§

fn add_labels<'life0, 'life1, 'async_trait>( &'life0 self, number: u64, labels: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

为指定 Issue 添加一个或多个标签。

调用 gh issue edit <number> --repo <repo> --add-label <label> 逐个添加标签。 如果 labels 为空,不进行任何调用并返回成功。

§自动创建缺失标签

当 gh issue edit --add-label 因标签不存在而失败时,本方法会自动调用 gh label create 创建缺失的标签(使用默认颜色 ededed),然后重试原操作。 这避免了手动同步仓库标签列表的繁琐流程。

§Errors

当 Issue 不存在、标签创建失败或 gh CLI 调用失败时返回错误。

Source§

fn remove_label<'life0, 'life1, 'async_trait>( &'life0 self, number: u64, label: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

从指定 Issue 移除一个标签。

调用 gh issue edit <number> --repo <repo> --remove-label <label> 移除标签。

§Errors

当 Issue 不存在、标签未附加到该 Issue 或 gh CLI 调用失败时返回错误。

Source§

fn create<'life0, 'async_trait>( &'life0 self, args: CreateIssueArgs, ) -> Pin<Box<dyn Future<Output = Result<IssueData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

创建一条新 Issue,返回平台生成的完整数据。 Read more
Source§

fn list<'life0, 'async_trait>( &'life0 self, args: ListIssueArgs, ) -> Pin<Box<dyn Future<Output = Result<Paged<IssueData>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

根据过滤条件列出 Issue 列表。 Read more
Source§

fn view<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<IssueData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

查看指定编号的 Issue 详情。 Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more