GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API to create repository tags for a specified project. It is useful for automating version control workflows, such as tagging releases or marking specific commits in a GitLab project repository. For example, it can be used in CI/CD pipelines to programmatically create tags after successful builds.

Use Case Examples

  1. Creating a new tag in a GitLab project repository to mark a release version.
  2. Automating tagging of commits in a project repository as part of a deployment process.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the API request, default is GET but POST is used for creating tags.
Path Parameters Parameters included in the request path, specifically the project ID or URL-encoded path to identify the project where the tag will be created.

Output

JSON

  • id - The ID or URL-encoded path of the project where the tag is created.
  • tag_name - The name of the tag created in the repository.
  • message - Optional message associated with the tag.
  • release_description - Description of the release associated with the tag.
  • commit_sha - The commit SHA the tag points to.

Dependencies

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct to avoid 404 errors.
  • Verify that the API key has sufficient permissions to create tags in the project repository.
  • Check the base URL if using a self-hosted GitLab instance to avoid connection errors.

Links

Discussion