GitLab API

GitlabTool
Join our community

Actions1000

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 and specify the changelog request, including version, from commit, to commit, date, trailer, and config file path.
Path Parameters Path parameters for the API request, specifically the project ID or URL-encoded path.

Output

JSON

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

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID is correctly specified and URL-encoded if necessary.
  • Verify that the version parameter is provided and follows semantic versioning format.
  • Check that authentication credentials are valid unless skipping authentication is enabled.
  • Confirm the base URL is correct for the GitLab instance being accessed.
  • If the changelog is empty, verify the commit range (from and to) and other query parameters are accurate.

Links

Discussion