GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Release → Update

AI-generated

Overview

This node operation updates an existing release in a specified GitHub repository. It allows users to modify various attributes of a release such as its body content, draft status, name, prerelease status, tag name, and target commitish. This operation is useful for managing release versions in software projects hosted on GitHub, enabling automation of release updates without manual intervention on the GitHub platform.

Use Case Examples

  1. Updating the release notes (body) of a specific release to provide more detailed information about the changes.
  2. Changing a release from draft to published status after final review.
  3. Modifying the tag name or target commitish to correct or update the release reference.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the release exists. This can be selected from a list, provided as a URL, or entered by name.
Repository Name The name of the GitHub repository containing the release. Can be selected from a list, provided as a URL, or entered by name.
Release ID The unique identifier of the release to update. This is required to specify which release to modify.
Additional Fields Optional fields to update on the release, including body (release notes), draft status, name, prerelease status, tag name, and target commitish (branch or commit SHA).

Output

JSON

  • success - Indicates successful deletion when the operation is delete (not applicable for update).
  • id - The unique identifier of the updated release.
  • tag_name - The tag name of the updated release.
  • name - The name of the updated release.
  • body - The body text or release notes of the updated release.
  • draft - Indicates if the release is a draft.
  • prerelease - Indicates if the release is a prerelease.
  • target_commitish - The commitish reference for the release tag.

Dependencies

  • GitHub API
  • GitHub App authentication with API key credentials

Troubleshooting

  • Ensure the Release ID is correct and corresponds to an existing release in the specified repository.
  • Verify that the repository owner and repository name are correctly specified and accessible with the provided credentials.
  • Check that the GitHub App authentication credentials are valid and have the necessary permissions to update releases.
  • If the API returns a 404 error, confirm that the release exists and the user has access rights.
  • Invalid JSON in additional fields or parameters may cause errors; ensure proper formatting.

Links

Discussion