GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves the changelog of a project's repository from GitLab using the GitLab API v4. It is useful for developers and project managers who want to get detailed information about the changes made in a specific version of a project, including commit ranges and release dates. For example, it can be used to automate release notes generation or to track changes between specific commits.

Use Case Examples

  1. Get the changelog for project ID 1 for version 1.0.0.
  2. Retrieve changelog between two commits for a project to see detailed changes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance, default is https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the changelog request including project ID, version, commit range, date, trailer, and config file path.
Query Parameters Collection of optional query parameters such as version, from commit, to commit, date, trailer, and config file path to customize the changelog request.
Path Parameters Collection containing the project ID or URL-encoded path to identify the project for which the changelog is requested.

Output

JSON

  • changelog - The changelog data retrieved from the GitLab project repository, including details about commits and release information.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID is correct and accessible with the provided authentication.
  • Verify that the version parameter is provided as it is required for the changelog request.
  • Check network connectivity and base URL correctness if the API request fails.
  • If authentication is skipped, ensure the GitLab instance allows unauthenticated access to the project repository.

Links

Discussion