GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves details of a specific release from a GitLab project using the GitLab API v4. It is useful for scenarios where you need to fetch release information by specifying the project ID or URL-encoded path and the release tag name. For example, it can be used to automate release monitoring, generate release notes, or integrate release data into other workflows.

Use Case Examples

  1. Fetch release details for a project by its ID and tag name to display release notes in a dashboard.
  2. Automatically retrieve release information to trigger deployment pipelines based on release tags.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, such as including HTML rendered markdown of the release description.
Path Parameters Required path parameters to identify the project and release tag.

Output

JSON

  • id - Unique identifier of the release.
  • tag_name - The Git tag name associated with the release.
  • description - Description of the release.
  • name - Name of the release.
  • created_at - Timestamp when the release was created.
  • released_at - Timestamp when the release was released.
  • author - Information about the author of the release.
  • commit - Commit details associated with the release.
  • assets - Assets related to the release, such as links and sources.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and tag name are correctly URL-encoded to avoid 404 errors.
  • If authentication is skipped, the request may fail due to lack of permissions.
  • Check that the base URL is correct for self-hosted GitLab instances.
  • If the 'include_html_description' query parameter is used, ensure it is a boolean value ('true' or 'false').

Links

Discussion