GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates metadata for a specific pipeline within a GitLab project using the GitLab API. It is useful for automating the management of pipeline metadata, such as adding or modifying information related to a pipeline's execution or status. For example, a DevOps engineer might use this node to programmatically update pipeline metadata as part of a CI/CD workflow.

Use Case Examples

  1. Updating metadata for a pipeline in a GitLab project to reflect new status information or tags.
  2. Automating the addition of custom metadata to pipelines for tracking and reporting purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API 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 PUT for this operation.
Path Parameters Parameters specifying the project ID or URL-encoded path and the pipeline ID to identify the pipeline whose metadata is being updated.

Output

JSON

  • response - The JSON response from the GitLab API after updating the pipeline metadata, containing the updated metadata details.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and pipeline ID are correctly specified and exist in the GitLab instance to avoid 'not found' errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to update pipeline metadata.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion