GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a submodule in a GitLab project's repository using the GitLab API. It is useful for managing and modifying submodules within a project's repository, such as changing the submodule's URL or updating its reference. Practical examples include automating repository maintenance tasks or integrating submodule updates into CI/CD pipelines.

Use Case Examples

  1. Update a submodule URL in a GitLab project repository.
  2. Automate submodule reference updates as part of a deployment workflow.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is PUT for this operation.
Path Parameters Parameters for the request path, including the project ID or URL-encoded path and the URL-encoded full path to the submodule.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and submodule path are correctly URL-encoded to avoid request errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to update repository submodules.
  • Common error messages may include 404 Not Found if the project or submodule does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion