GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the commit sequence information for a specific commit SHA in a GitLab project repository. It is useful for developers or DevOps engineers who need to analyze the commit history or sequence related to a particular commit in a project hosted on GitLab. For example, it can be used to track the sequence of changes leading up to a commit or to understand the commit ancestry in a project.

Use Case Examples

  1. Retrieve the commit sequence for a given commit SHA in a project to analyze the commit history.
  2. Use the commit sequence data to visualize the commit ancestry or to automate release notes generation based on commit sequences.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the required path and query parameters for the operation, including project ID, commit SHA, and an optional first_parent boolean to filter merge parents.
Request Body Schema The schema for the request body, which is null for this GET operation.
Request Path The API endpoint path for the operation, including placeholders for project ID and commit SHA.
Query Parameters Optional query parameters for the request, including first_parent to include only the first parent of merges.
Path Parameters Path parameters required for the request, including the project ID and commit SHA.

Output

JSON

  • commitSequence - The sequence information of the commit retrieved from the GitLab API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and commit SHA are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the repository commits.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If the first_parent query parameter is used, ensure it is a boolean value; otherwise, the API may return unexpected results.

Links

Discussion