GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the changelog of a project's repository from GitLab using the GitLab API. It is useful for obtaining detailed information about the changes made in a specific version or range of commits within a project repository. Common scenarios include generating release notes, tracking changes between commits, or auditing project history.

Use Case Examples

  1. Fetch the changelog for a specific project version to generate release notes.
  2. Retrieve the changelog between two commits to review changes before deployment.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication The authentication method used for the API request, 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 API request, defaulting to GET.
Query Parameters Parameters to filter or specify the changelog details, including version, commit range, date, trailer, and config file path.
Path Parameters The project identifier, which can be the ID or URL-encoded path of the project.

Output

JSON

  • changelog - The changelog data retrieved from the project's repository.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or path is correct to avoid '404 Not Found' errors.
  • Verify that the version parameter is provided as it is required for the request.
  • Check API authentication credentials if authentication is not skipped.
  • Validate the date format if provided, it should be in ISO 8601 date-time format.
  • If the changelog configuration file path is customized, ensure it exists in the repository to avoid errors.

Links

Discussion