GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to create a new release for a specified project. It is useful for automating release management in GitLab projects, such as tagging new versions or deploying software updates. For example, it can be used in CI/CD workflows to programmatically create releases after successful builds.

Use Case Examples

  1. Creating a release for a project by specifying the project ID and release details.
  2. Automating release creation in a GitLab project as part of a deployment pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET but set to POST for creating releases.
Parameter Schema Defines the required parameters for the operation, including the project ID in the path and the release data in the request body.
Request Body Schema Schema defining the structure of the request body for creating a release.
Request Path The API endpoint path for creating a release, including a placeholder for the project ID.
Path Parameters Collection of path parameters, specifically the project ID required to identify the project for which the release is created.

Output

JSON

  • id - The unique identifier of the created release.
  • tag_name - The tag name associated with the release.
  • description - Description or notes about the release.
  • created_at - Timestamp when the release was created.
  • released_at - Timestamp when the release was officially released.
  • author
    • name - Name of the author who created the release.
    • email - Email of the author who created the release.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials (GitLab API key) are valid and have sufficient permissions to create releases.
  • Check the request body schema to ensure all required fields for the release creation are included and correctly formatted.
  • Common error messages include authentication failures (401 Unauthorized), missing or invalid project ID (404 Not Found), and validation errors for the release data (400 Bad Request). Resolving these involves correcting credentials, verifying project existence, and validating request payloads.

Links

Discussion