Forgejo icon

Forgejo

Interact with Forgejo API

Overview

This node operation updates an existing release in a Forgejo repository. It allows users to modify the release's name, body (release notes), and flags indicating whether the release is a draft or a prerelease. This operation is useful for maintaining and managing release information in software projects hosted on Forgejo, enabling automation of release updates such as correcting release notes or changing release status.

Use Case Examples

  1. Updating the release notes of a specific release to provide more detailed information about the changes.
  2. Marking a release as a draft to prevent it from being publicly visible until finalized.
  3. Changing a release to a prerelease to indicate it is a beta or test version before the final release.

Properties

Name Meaning
Owner The username or organization that owns the repository where the release exists.
Repository The name of the repository containing the release to update.
Release ID The unique identifier of the release to update.
Release Name The new name for the release (optional).
Body The release notes or description for the release (optional).
Draft Boolean flag indicating whether the release is a draft.
Prerelease Boolean flag indicating whether the release is a prerelease.

Output

JSON

  • json
    • id - The unique identifier of the updated release.
    • tag_name - The tag name associated with the release.
    • name - The name of the updated release.
    • body - The release notes or description of the updated release.
    • draft - Indicates if the release is a draft.
    • prerelease - Indicates if the release is a prerelease.
    • created_at - Timestamp when the release was created.
    • published_at - Timestamp when the release was published.

Dependencies

  • Forgejo API

Troubleshooting

  • Ensure that the 'Owner', 'Repository', and 'Release ID' fields are correctly specified, as these are required to identify the release to update.
  • If the API request fails, check the API credentials and server URL configuration for the Forgejo API.
  • Verify that the release ID exists in the specified repository; an invalid release ID will cause an error.
  • If optional fields like 'Release Name' or 'Body' are not provided, they will not be updated, so ensure to include all desired changes in the input.

Links

  • Forgejo API Documentation - Official API documentation for Forgejo, useful for understanding available endpoints and parameters for release management.

Discussion