Skip to main content

gitflow_gitlab/
lib.rs

1//! `gitflow-gitlab` -- GitLab platform implementation.
2//!
3//! This crate implements the `IssueProvider`, `PrProvider`,
4//! `ReleaseProvider`, `ReviewProvider`, `AuthProvider`, `LabelProvider`,
5//! `MilestoneProvider`, `CommitProvider` and `PipelineProvider` traits defined
6//! in `gitflow-core`, by calling the `glab` CLI to fetch data and parse
7//! its JSON output.
8//!
9//! # Main Types
10//!
11//! - `GitLabIssueProvider`: Operate GitLab Issues.
12//! - `GitLabMrProvider`: Operate GitLab Merge Requests (implements `PrProvider`).
13//! - `GitLabReleaseProvider`: Operate GitLab Releases.
14//! - `GitLabReviewProvider`: Operate GitLab MR Reviews.
15//! - `GitLabAuthProvider`: Handle GitLab authentication (login, logout, status, token).
16//! - `GitLabLabelProvider`: Manage GitLab repository labels.
17//! - `GitLabMilestoneProvider`: Manage GitLab repository milestones.
18//! - `GitLabCommitProvider`: View GitLab commits and diff/patch.
19//! - `GitLabPipelineProvider`: View GitLab CI/CD pipelines.
20
21#![forbid(unsafe_code)]
22#![cfg_attr(
23    test,
24    allow(
25        clippy::expect_used,
26        clippy::unwrap_used,
27        clippy::indexing_slicing,
28        clippy::useless_format,
29        clippy::clone_on_copy,
30        reason = "Tests legitimately need to unwrap fixture data and index into known-shape \
31                  collections"
32    )
33)]
34
35pub mod auth;
36pub mod commit;
37pub mod error;
38pub mod issue;
39pub mod label;
40pub mod mr;
41pub mod pipeline;
42pub mod release;
43pub mod review;
44pub mod runner;
45
46pub use auth::GitLabAuthProvider;
47pub use commit::GitLabCommitProvider;
48pub use error::parse_glab_error;
49pub use issue::GitLabIssueProvider;
50pub use label::{GitLabLabelProvider, GitLabMilestoneProvider};
51pub use mr::GitLabMrProvider;
52pub use pipeline::GitLabPipelineProvider;
53pub use release::GitLabReleaseProvider;
54pub use review::GitLabReviewProvider;
55
56/// GitLab API 对单页条数的硬上限。
57///
58/// 传入更大的值不会报错,服务端会静默按 100 处理——这正是此前
59/// `--limit 1000` 在 GitLab 上只返回 100 条的原因。
60pub(crate) const GITLAB_MAX_PER_PAGE: u32 = 100;