GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to create a new repository tag for a specified project. It is useful for automating version control workflows, such as tagging releases or marking specific points in the project history. For example, a user can create a tag named 'v1.0' on a project to mark the first stable release.

Use Case Examples

  1. Creating a new tag 'v1.0' on a project with ID '12345' to mark a release.
  2. Automating tag creation in a CI/CD pipeline after successful builds.

Properties

Name Meaning
Skip Authentication Option to skip API authentication, useful for public or unauthenticated requests.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to POST for creating tags.
Path Parameters Parameters to specify the project ID or URL-encoded path for which the tag is created.

Output

JSON

  • id - The ID or URL-encoded path of the project for which the tag was created.
  • tag_name - The name of the created tag.
  • message - The message associated with the tag, if any.
  • release_description - Description of the release associated with the tag, if provided.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Verify that the HTTP method is set to POST when creating a new tag, as other methods will not create tags.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions to create tags.

Links

Discussion