GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation retrieves a specific Conan package file from a GitLab project using the GitLab API. It is useful for users who need to access detailed package files such as conanfile.py, conanmanifest.txt, or conan_package.tgz for a given project and package version. Practical examples include automating package management workflows, integrating package retrieval into CI/CD pipelines, or auditing package contents programmatically.

Use Case Examples

  1. Fetching the conanfile.py for a specific package version to inspect or modify the build recipe.
  2. Downloading the conan_package.tgz file to use the pre-built package in a deployment pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API requests are sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET.
Path Parameters Collection of parameters required to specify the exact Conan package file to retrieve, including project ID, package name, version, username, channel, recipe revision, and file name.

Output

JSON

  • fileContent - The content of the requested Conan package file retrieved from the GitLab API.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure all required path parameters are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API token has sufficient permissions to access the project and package files.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the package or file does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion