GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows publishing a project catalog entry in GitLab by making a POST request to the endpoint `/api/v4/projects/{id}/catalog/publish`. It is useful for automating the process of publishing project catalogs within GitLab, especially in CI/CD pipelines or project management workflows.

Use Case Examples

  1. Automatically publish a project catalog entry after a successful build in a CI/CD pipeline.
  2. Trigger project catalog publishing as part of a project release workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path.

Output

JSON

  • response - The response from the GitLab API after publishing the project catalog entry.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Verify that the authentication credentials are valid and have the necessary permissions to publish project catalogs.
  • 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 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID), or 403 Forbidden (insufficient permissions).

Links

Discussion