Forgejo icon

Forgejo

Interact with Forgejo API

Overview

This node interacts with the Forgejo API to perform operations related to branches in a repository. Specifically, the 'Get' operation for the 'Branch' resource retrieves detailed information about a specific branch within a given repository owned by a specified user or organization. This is useful for scenarios where you need to fetch branch metadata, such as commit details or branch protection status, for automation or integration workflows.

Use Case Examples

  1. Retrieve details of a branch named 'feature-xyz' in the repository 'my-repo' owned by 'my-org' to check its latest commit or status.
  2. Use the node to get branch information before performing further actions like merging or deleting the branch.

Properties

Name Meaning
Owner The username or organization that owns the repository.
Repository The name of the repository containing the branch.
Branch Name The name of the branch to retrieve information for.

Output

JSON

  • json - The JSON object containing the branch details returned from the Forgejo API.

Dependencies

  • Requires an API key credential for Forgejo API authentication.

Troubleshooting

  • Ensure the 'Owner', 'Repository', and 'Branch Name' parameters are correctly set and correspond to existing entities in the Forgejo instance.
  • Common errors include 404 Not Found if the branch does not exist, or authentication errors if the API key is invalid or missing.
  • Verify network connectivity to the Forgejo server URL configured in the credentials.

Links

  • Forgejo API Documentation - Official API documentation for Forgejo, useful for understanding the branch resource endpoints and parameters.

Discussion