GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a specific submodule in a project's repository on GitLab using the GitLab API. It is useful for managing submodules within a GitLab project repository, allowing users to modify submodule details programmatically. For example, it can be used to update the URL or configuration of a submodule in a CI/CD pipeline or automation workflow.

Use Case Examples

  1. Updating a submodule URL in a GitLab project repository to point to a new repository location.
  2. Automating the management of submodules in multiple projects by updating their configurations via API calls.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method used for the API request, default is GET but PUT is used for this operation.
Path Parameters Parameters for the API path including project ID and submodule path.

Output

JSON

  • response - The JSON response from the GitLab API after updating the submodule.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and submodule path are correctly URL-encoded to avoid 404 errors.
  • Authentication errors may occur if the API key is missing or invalid; verify credentials are correctly configured.
  • Check that the HTTP method is set to PUT for this operation to update the submodule.
  • API rate limits or permission issues on GitLab may cause request failures; ensure the API key has sufficient permissions.

Links

Discussion