GitLab API

GitlabTool

Actions905

Overview

This node operation retrieves a specific Maven package file from a GitLab group using the GitLab API. It is useful for automating the download or inspection of Maven package files stored within GitLab groups, such as fetching a particular JAR file for build or deployment processes.

Use Case Examples

  1. Fetch a Maven package file named 'mypkg-1.0-SNAPSHOT.jar' from a group identified by 'my-group' to use in a CI/CD pipeline.
  2. Retrieve a specific version of a Maven package stored in a GitLab group for auditing or backup purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the 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 HTTP method to use for the request, default is GET.
Query Parameters Query parameters for the request, specifically the 'path' parameter indicating the package path.
Path Parameters Path parameters for the request including 'id' (group ID or URL-encoded path) and 'file_name' (the Maven package file name).

Output

JSON

  • id - The ID or URL-encoded path of the GitLab group.
  • path - The package path query parameter specifying the Maven package location.
  • file_name - The Maven package file name being retrieved.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the 'id' parameter correctly identifies the GitLab group and is URL-encoded if necessary.
  • Verify the 'file_name' matches exactly the Maven package file name stored in the group.
  • Check that the 'path' query parameter correctly specifies the package path within the Maven repository.
  • If authentication is enabled, confirm the GitLab API key credential is valid and has sufficient permissions to access the group packages.
  • Network or permission errors may occur if the baseUrl is incorrect or the GitLab instance is unreachable.

Links

Discussion