GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a release associated with a specific Git tag in a GitLab project using the GitLab API. It is useful for managing project releases programmatically, such as modifying release notes or metadata tied to a tag. For example, a user can update the release description or assets for a given tag in a project repository.

Use Case Examples

  1. Updating release notes for a specific tag in a GitLab project.
  2. Modifying release metadata such as release name or description for a tagged release.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is PUT.
Path Parameters Parameters in the request path identifying the project and tag name to update the release for.

Output

JSON

  • id - The unique identifier of the release.
  • tag_name - The Git tag associated with the release.
  • name - The name of the release.
  • description - The description or release notes.
  • 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 the release is based on.
  • assets - Assets associated with the release, such as links or sources.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and tag name are correctly URL-encoded and valid to avoid 404 errors.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials are correctly configured.
  • The API may reject the request if the request body schema does not conform to the expected format; validate the request body against the GitLab API documentation.

Links

Discussion