GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the changelog of a project's repository from GitLab using the GitLab API v4. It is useful for obtaining detailed information about the changes made in a specific version of a project, including commit ranges and release dates. Practical applications include automating release notes generation, tracking project changes, and integrating changelog data into CI/CD pipelines.

Use Case Examples

  1. Fetch the changelog for a specific project version to generate release notes automatically.
  2. Retrieve commit changes between two commits to analyze recent updates in a project repository.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, default is GET.
Query Parameters Parameters to filter and specify the changelog request, including version, commit range, release date, trailer, and config file path.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project.

Output

JSON

  • changelog - The changelog data retrieved from the project's repository, detailing commits and changes for the specified version and parameters.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID or path is correct and URL-encoded if necessary to avoid 404 errors.
  • Verify that the version parameter is provided and follows semantic versioning format to get accurate changelog data.
  • Check API authentication credentials if receiving authorization errors.
  • If optional parameters like 'from', 'to', or 'date' are used, ensure they are valid commit hashes or date-time strings to avoid request failures.

Links

Discussion