GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves comments on a specific commit in a GitLab project repository. It is useful for developers and project managers who want to review or analyze feedback and discussions related to particular commits in their GitLab projects. For example, it can be used to fetch all comments on a commit to track code review discussions or to automate reporting on commit feedback.

Use Case Examples

  1. Fetch comments on a commit to review code review feedback.
  2. Automate retrieval of commit comments for audit or reporting purposes.

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.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request.
Parameter Schema Defines the required and optional parameters for the API request, including project ID, commit SHA, and pagination options.
Query Parameters Optional query parameters for pagination such as page number and items per page.
Path Parameters Required path parameters including the project ID and commit SHA to identify the specific commit.

Output

JSON

  • comments - Array of comments on the specified commit, including details such as comment text, author, and timestamps.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and commit SHA are correctly specified and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to access the project's repository commits and comments.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause errors or unexpected results.

Links

Discussion