GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves a specific Conan package from a GitLab project using the GitLab API. It is useful for developers and DevOps engineers who need to access detailed information about a Conan package stored in a GitLab project's package registry. For example, it can be used to fetch package metadata for version control, dependency management, or automation workflows involving Conan packages.

Use Case Examples

  1. Fetch a Conan package named 'my-package' version '1.0' from a GitLab project with ID '123', specifying the package username and channel to verify package details before deployment.
  2. Automate retrieval of Conan package information in CI/CD pipelines to ensure the correct package version is used.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Path Parameters Parameters required in the API request path to identify the specific Conan package.

Output

JSON

  • id - The unique identifier of the Conan package.
  • name - The name of the Conan package.
  • version - The version of the Conan package.
  • username - The username associated with the package.
  • channel - The channel of the package.
  • metadata - Additional metadata related to the Conan package.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure all required path parameters (id, package_name, package_version, package_username, package_channel) are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API credentials are valid and have sufficient permissions to access the project and package registry.
  • Check the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (incorrect project or package details), and 400 Bad Request (invalid parameters). Resolving these involves verifying credentials, parameters, and API endpoint correctness.

Discussion