GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves a specific release from a GitLab project by using the project's ID or URL-encoded path and the release's associated Git tag name. It is useful for scenarios where you need detailed information about a particular release in a GitLab project, such as fetching release notes or metadata for deployment automation or reporting.

Use Case Examples

  1. Fetch release details for a project with ID '123' and tag name 'v1.0.0'.
  2. Retrieve release information including HTML-rendered markdown description by setting the 'include_html_description' query parameter to true.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Query Parameters Optional query parameters for the request, including 'include_html_description' to include HTML rendered markdown of the release description.
Path Parameters Required path parameters including 'id' for the project ID or URL-encoded path, and 'tag_name' for the Git tag associated with the release.

Output

JSON

  • id - The unique identifier of the release.
  • tag_name - The Git tag name associated with the release.
  • description - The description of the release, optionally including HTML rendered markdown.
  • created_at - The timestamp when the release was created.
  • released_at - The timestamp when the release was released.
  • author - Information about the author of the release.
  • assets - Assets associated with the release, such as links or sources.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID or URL-encoded path and tag name are correctly specified; otherwise, the API will return an error indicating the release was not found.
  • If authentication is skipped or credentials are invalid, the request will fail with an authentication error; verify the API token or credentials are correctly configured.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct and accessible.

Links

Discussion