ironflow-ops-gitlab

GitLab integration for Ironflow workflows, powered by the gitlab crate.

Provides typed, builder-based access to every GitLab API v4 endpoint with automatic credential resolution from the workflow's secret store.

Usage

[dependencies]
ironflow-ops-gitlab = "0.1"

Build a client

use ironflow_ops_gitlab::GitLab;

// From a workflow step (reads gitlab_token from the secret store)
let gitlab = GitLab::from_context(&ctx).await?;

// Self-hosted instance
let gitlab = GitLab::from_context_with_host(&ctx, "gitlab.example.com").await?;

// Explicit token
let gitlab = GitLab::new("glpat-xxxx", "gitlab.com").await?;

use ironflow_ops_gitlab::GitLab;
use gitlab::GitlabBuilder;

// From an already configured AsyncGitlab (e.g. wiremock in tests, custom TLS)
let client = GitlabBuilder::new("gitlab.example.com", "glpat-xxxx")
    .insecure()
    .build_async()
    .await?;
let gitlab: GitLab = client.into();

Typed queries

Use the re-exported gitlab::api builders for type-safe endpoint calls:

use ironflow_ops_gitlab::GitLab;
use gitlab::api::{projects, AsyncQuery};
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct Project {
    id: u64,
    name: String,
}

let gitlab = GitLab::from_context(&ctx).await?;
let endpoint = projects::Project::builder().project(42).build()?;
let project: Project = endpoint.query_async(gitlab.client()).await?;

Tracked operations

Wrap any endpoint in a tracked workflow step:

use ironflow_ops_gitlab::GitLab;
use gitlab::api::projects::issues::CreateIssue;

let gitlab = GitLab::from_context(&ctx).await?;

let endpoint = CreateIssue::builder()
    .project("my-group/my-project")
    .title("Bug report")
    .description("Steps to reproduce...")
    .build()?;

// Tracked as a workflow step with kind "gitlab"
let output = ctx.operation("create-issue", &gitlab.op(endpoint)).await?;

Endpoints not in the `gitlab` crate

Some GitLab REST routes are missing from the gitlab crate. This crate provides them under endpoints, wired the same way as any other endpoint:

use ironflow_ops_gitlab::GitLab;
use ironflow_ops_gitlab::endpoints::merge_requests::{
    CreateMergeRequestDiscussionNote, ResolveMergeRequestDiscussion,
};
use gitlab::api::common::NameOrId;

let gitlab = GitLab::from_context(&ctx).await?;

let note = CreateMergeRequestDiscussionNote {
    project: NameOrId::from(42),
    merge_request: 7,
    discussion_id: "abcd1234".to_string(),
    body: "Looks good, thanks!".to_string(),
};
let output = ctx.operation("reply-to-discussion", &gitlab.op(note)).await?;

let resolve = ResolveMergeRequestDiscussion {
    project: NameOrId::from(42),
    merge_request: 7,
    discussion_id: "abcd1234".to_string(),
    resolved: true,
};
let output = ctx.operation("resolve-discussion", &gitlab.op(resolve)).await?;

Paginated operations

GitLab::op issues a single request, so it only ever returns the first page of a "list ..." endpoint. Use GitLab::paged_op to drive pagination and get back a JSON array concatenating every page:

use ironflow_ops_gitlab::GitLab;
use gitlab::api::projects::merge_requests::MergeRequests;
use gitlab::api::Pagination;

let gitlab = GitLab::from_context(&ctx).await?;

let endpoint = MergeRequests::builder().project(42).build()?;
let output = ctx
    .operation("list-merge-requests", &gitlab.paged_op(endpoint, Pagination::All))
    .await?;

Authentication

secrets:
  - name: gitlab_token
    env: GITLAB_TOKEN

API coverage

This crate re-exports the full gitlab API. All endpoints available in that crate are available here, including:

Projects, groups, users
Issues, merge requests, notes, discussions
Pipelines, jobs, artifacts
Repository files, branches, tags, commits
Releases, deployments, environments
CI/CD variables, runners, registry
Labels, milestones, wikis, snippets, packages
And more -- see the gitlab crate docs

ironflow-ops-gitlab 0.1.15