GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves Composer package information from a specific GitLab group using the GitLab API. It is useful for developers or DevOps engineers who need to access package details based on a group's ID and a specific SHA checksum. For example, it can be used to verify package integrity or fetch package metadata for automation workflows involving GitLab package registries.

Use Case Examples

  1. Fetch Composer package details for a GitLab group by providing the group's ID and the SHA checksum of the package JSON.
  2. Automate validation of Composer packages in a CI/CD pipeline by retrieving package data from GitLab.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, 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.
Path Parameters Parameters for the API request path, including the group ID and the SHA checksum of the package JSON.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab group.
  • sha - The SHA checksum of the Composer package JSON.
  • packageData - The retrieved Composer package information from the GitLab group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID and SHA parameters are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the group's package registry.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, 404 not found if the group or package SHA does not exist, and 400 bad request if parameters are malformed.

Links

Discussion