Struct ReleasesClient 

pub struct ReleasesClient { /* private fields */ }

Domain client for release operations.

Obtained via InstallationClient::releases(). Cheap to clone (Arc-backed).

See docs/specs/interfaces/additional-operations.md

Implementations

impl ReleasesClient

pub async fn list( &self, owner: &str, repo: &str, ) -> Result<Vec<Release>, ApiError>

List releases in a repository.

Retrieves all releases for a repository, including drafts and prereleases.

Arguments

• owner - Repository owner
• repo - Repository name

Returns

Returns vector of releases ordered by creation date (newest first).

Errors

• ApiError::NotFound - Repository does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let releases = client.list("owner", "repo").await?;
for release in releases {
    println!("Release: {} ({})", release.name.unwrap_or_default(), release.tag_name);
}

pub async fn get_latest( &self, owner: &str, repo: &str, ) -> Result<Release, ApiError>

Get the latest published release.

Returns the most recent non-draft, non-prerelease release.

Arguments

• owner - Repository owner
• repo - Repository name

Returns

Returns the latest published Release.

Errors

• ApiError::NotFound - Repository or no published releases exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let release = client.get_latest("owner", "repo").await?;
println!("Latest: {} ({})", release.name.unwrap_or_default(), release.tag_name);

pub async fn get_by_tag( &self, owner: &str, repo: &str, tag: &str, ) -> Result<Release, ApiError>

Get a release by tag name.

Retrieves a release by its git tag name.

Arguments

• owner - Repository owner
• repo - Repository name
• tag - Git tag name

Returns

Returns the Release with the specified tag.

Errors

• ApiError::NotFound - Release with tag does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let release = client.get_by_tag("owner", "repo", "v1.0.0").await?;
println!("Release: {}", release.tag_name);

pub async fn get( &self, owner: &str, repo: &str, release_id: u64, ) -> Result<Release, ApiError>

Get a release by ID.

Retrieves a release by its unique identifier.

Arguments

• owner - Repository owner
• repo - Repository name
• release_id - Release ID

Returns

Returns the Release with the specified ID.

Errors

• ApiError::NotFound - Release does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let release = client.get("owner", "repo", 12345).await?;
println!("Release: {}", release.tag_name);

pub async fn create( &self, owner: &str, repo: &str, request: CreateReleaseRequest, ) -> Result<Release, ApiError>

Create a new release.

Creates a new release for a repository. Can create published releases, drafts, or prereleases.

Arguments

• owner - Repository owner
• repo - Repository name
• request - Release creation parameters

Returns

Returns the created Release.

Errors

• ApiError::InvalidRequest - Tag already exists or invalid parameters
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let request = CreateReleaseRequest {
    tag_name: "v1.0.0".to_string(),
    name: Some("Version 1.0.0".to_string()),
    body: Some("Release notes".to_string()),
    draft: Some(false),
    prerelease: Some(false),
    target_commitish: None,
    generate_release_notes: None,
};
let release = client.create("owner", "repo", request).await?;
println!("Created release: {}", release.tag_name);

pub async fn update( &self, owner: &str, repo: &str, release_id: u64, request: UpdateReleaseRequest, ) -> Result<Release, ApiError>

Update an existing release.

Updates release properties. Only specified fields are modified.

Arguments

• owner - Repository owner
• repo - Repository name
• release_id - Release ID
• request - Fields to update

Returns

Returns the updated Release.

Errors

• ApiError::NotFound - Release does not exist
• ApiError::InvalidRequest - Invalid parameters
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let request = UpdateReleaseRequest {
    name: Some("Updated name".to_string()),
    body: Some("Updated notes".to_string()),
    ..Default::default()
};
let release = client.update("owner", "repo", 12345, request).await?;
println!("Updated release: {}", release.tag_name);

pub async fn delete( &self, owner: &str, repo: &str, release_id: u64, ) -> Result<(), ApiError>

Delete a release.

Deletes a release. Does not delete the associated git tag.

Arguments

• owner - Repository owner
• repo - Repository name
• release_id - Release ID

Returns

Returns Ok(()) on successful deletion.

Errors

• ApiError::NotFound - Release does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

client.delete("owner", "repo", 12345).await?;
println!("Release deleted");

Trait Implementations

impl Clone for ReleasesClient

fn clone(&self) -> ReleasesClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleasesClient

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

Formats the value using the given formatter.