GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the commit sequence information for a specific commit SHA within a GitLab project repository. It is useful for scenarios where you need to analyze or track the sequence of commits related to a particular commit in a project, such as in version control workflows or audit trails.

Use Case Examples

  1. Get the commit sequence for a specific commit SHA in a GitLab project to understand its parent commits and merge history.
  2. Use the commit sequence data to visualize the commit ancestry or to automate release notes generation based on commit history.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making 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 used for the API request, default is GET.
Query Parameters Optional query parameters for the API request, including 'first_parent' to include only the first parent of merges.
Path Parameters Required path parameters identifying the project and commit SHA.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • sha - The commit SHA.
  • sequence - The sequence information of the commit, including parent commits and merge details.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and commit SHA are correctly provided and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to access the repository commits.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • If skipping authentication, ensure the API endpoint allows unauthenticated access, otherwise the request will fail.

Links

Discussion