GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a summary of the test report for a specific pipeline within a GitLab project. It is useful for developers and DevOps teams who want to programmatically access test results associated with a pipeline to monitor build quality and test coverage. For example, it can be used to fetch test report summaries to integrate with CI/CD dashboards or automated reporting tools.

Use Case Examples

  1. Fetch the test report summary for pipeline ID 18 in project ID 11 to monitor test results after a build.
  2. Integrate with GitLab API to automatically retrieve and display pipeline test summaries in a custom dashboard.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Path Parameters Parameters to specify the project ID or URL-encoded path and the pipeline ID for which the test report summary is requested.

Output

JSON

  • test_report_summary - Summary of the test report for the specified pipeline in the project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and pipeline ID are correctly specified and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access the project's pipeline test reports.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, resource not found (404), or permission denied (403). Verify credentials and resource identifiers to resolve these issues.

Links

Discussion