Skip to main content

gitflow_github/
lib.rs

1//! `gitflow-github` —— GitHub 平台实现。
2//!
3//! 本 crate 实现了 `gitflow-core` 中定义的 [`IssueProvider`]、[`PrProvider`]、
4//! [`ReleaseProvider`]、[`ReviewProvider`]、[`AuthProvider`]、[`LabelProvider`]、
5//! [`MilestoneProvider`] 与 [`CommitProvider`] trait,
6//! 通过调用 `gh` CLI 获取数据并解析其 JSON 输出。
7//!
8//! # 主要类型
9//!
10//! - [`GitHubIssueProvider`]:操作 GitHub Issue。
11//! - [`GitHubPrProvider`]:操作 GitHub Pull Request。
12//! - [`GitHubReleaseProvider`]:操作 GitHub Release。
13//! - [`GitHubReviewProvider`]:操作 GitHub PR Review。
14//! - [`GitHubAuthProvider`]:处理 GitHub 认证(登录、登出、状态、Token)。
15//! - [`GitHubLabelProvider`]:管理 GitHub 仓库标签。
16//! - [`GitHubMilestoneProvider`]:管理 GitHub 仓库里程碑。
17//! - [`GitHubCommitProvider`]:查看 GitHub Commit 及 Diff/Patch。
18//!
19//! # 错误处理
20//!
21//! 所有平台调用失败时,`gh` 的 stderr 会通过 [`error::parse_gh_error`] 解析,
22//! 并统一映射为 [`CoreError::Cli`](携带 [`PlatformCliError`])。
23//!
24//! [`IssueProvider`]: gitflow_core::issue::IssueProvider
25//! [`PrProvider`]: gitflow_core::pr::PrProvider
26//! [`ReleaseProvider`]: gitflow_core::release::ReleaseProvider
27//! [`ReviewProvider`]: gitflow_core::review::ReviewProvider
28//! [`AuthProvider`]: gitflow_core::auth::AuthProvider
29//! [`LabelProvider`]: gitflow_core::label::LabelProvider
30//! [`MilestoneProvider`]: gitflow_core::label::MilestoneProvider
31//! [`CommitProvider`]: gitflow_core::commit::CommitProvider
32//! [`CoreError::Cli`]: gitflow_core::CoreError::Cli
33//! [`PlatformCliError`]: gitflow_core::PlatformCliError
34
35#![forbid(unsafe_code)]
36
37pub mod auth;
38pub mod commit;
39pub mod error;
40pub mod issue;
41pub mod label;
42pub mod pipeline;
43pub mod pr;
44pub mod release;
45pub mod review;
46pub mod runner;
47
48pub use auth::GitHubAuthProvider;
49pub use commit::GitHubCommitProvider;
50pub use issue::GitHubIssueProvider;
51pub use label::{GitHubLabelProvider, GitHubMilestoneProvider};
52pub use pipeline::GitHubPipelineProvider;
53pub use pr::GitHubPrProvider;
54pub use release::GitHubReleaseProvider;
55pub use review::GitHubReviewProvider;