GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific release from a GitLab project by using the project's ID or URL-encoded path and the Git tag associated with the release. 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 or auditing purposes.

Use Case Examples

  1. Fetch release details for a project with ID '123' and tag 'v1.0.0' to display release notes in a dashboard.
  2. Retrieve release information including HTML-rendered description for a project to automate release announcements.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is 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 identifying the project and release tag.

Output

JSON

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

Dependencies

  • GitLab API authentication token or credentials

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 baseUrl is correctly set to the GitLab instance you are querying.
  • If 'include_html_description' is set to true, ensure the API version supports this parameter to avoid unexpected results.

Links

Discussion