GitLab Extended icon

GitLab Extended

Extended GitLab node
Join our community

Actions66

Overview

The node "GitLab Extended" provides extended integration capabilities with GitLab, allowing users to interact with various GitLab resources such as branches, files, tags, releases, groups, projects, issues, merge requests, pipelines, and raw API endpoints. Specifically, for the File resource with the List operation, this node lists files in a GitLab repository at a specified path and reference (branch or commit SHA).

This node is beneficial when automating workflows that require fetching file listings from GitLab repositories, such as:

  • Retrieving directory contents to trigger further processing.
  • Auditing or monitoring repository files.
  • Integrating GitLab file data into other systems or dashboards.

Example use case: Automatically list all files under src/components on the main branch of a project to generate documentation or perform batch operations.

Properties

Name Meaning
Authentication Choose between using saved credentials ("Credential") or specifying custom connection details ("Custom").
GitLab Server Base URL of your GitLab instance, e.g., https://gitlab.com. Used only if "Custom" authentication is selected.
Access Token Personal access token with API permissions. Used only if "Custom" authentication is selected.
Project Owner Namespace or owner of the project. Ignored if "Project ID" is set. Used only if "Custom" authentication is selected.
Project Name Project slug or name. Ignored if "Project ID" is set. Used only if "Custom" authentication is selected.
Project ID Numeric project ID. Takes precedence over owner and name if provided. Used only if "Custom" authentication is selected.
Ref Branch or commit SHA to list files from, e.g., main. Required. Defaults to main.
Path Path within the repository to list files from, e.g., src/index.ts. Required.
Return All Whether to return all results or limit the number of returned files. Optional, default is false.
Limit Maximum number of files to return if "Return All" is false. Optional, default is 50.
Reference (fileRef) Reference such as a branch or commit SHA for file operations. Optional, defaults to main.

Output

The node outputs an array of JSON objects representing files found at the specified path and reference in the GitLab repository. Each object typically contains metadata about a file or directory entry, such as its name, type (file or directory), size, and path.

If binary data output is supported (not explicitly shown for the List operation), it would represent file contents or artifacts, but for listing files, the output is purely JSON metadata.

Dependencies

  • Requires access to a GitLab instance, either the public https://gitlab.com or a self-hosted GitLab server.
  • Requires an API access token with appropriate permissions to read repository files.
  • Supports two authentication modes: using stored credentials or custom fields for server URL and access token.
  • No additional external dependencies beyond standard HTTP API calls to GitLab.

Troubleshooting

  • Invalid or missing credentials: Ensure the access token has sufficient API permissions and is correctly configured.
  • Project identification errors: If both Project ID and Project Owner/Name are provided, Project ID takes precedence. Make sure the project exists and the ID or namespace/name is correct.
  • Path not found: Verify the specified path exists in the given branch or commit reference.
  • Rate limiting or API errors: GitLab may throttle API requests; consider enabling pagination and respecting limits.
  • JSON parsing errors: Not applicable for listing files but relevant if using JSON input parameters elsewhere.

Common error messages:

  • "Unknown resource": Indicates an unsupported resource was requested.
  • "tagName must not be empty": For tag-related operations, ensure required parameters are provided.
  • Validation errors for numeric IDs if negative or zero values are used where positive integers are expected.

Links and References

Discussion