GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Release → Create

AI-generated

Overview

This node operation creates a new release in a specified GitHub repository. It is useful for automating the release process in software development workflows, allowing users to programmatically tag and publish new versions of their projects. For example, it can be used to create a release with a specific tag, name, description, and other optional settings such as draft status or prerelease indication.

Use Case Examples

  1. Automatically create a release when a new version is pushed to the main branch.
  2. Create a draft release for internal testing before publishing it publicly.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the release will be created. This can be selected from a list, provided as a URL, or entered by name.
Repository Name The name of the GitHub repository where the release will be created. This can be selected from a list, provided as a URL, or entered by name.
Tag The tag of the release, which identifies the version or milestone for the release. This is a required field.
Additional Fields Optional additional settings for the release, including name, body (description), draft status, prerelease status, and target commitish (branch or commit SHA).

Output

JSON

  • id - The unique identifier of the created release.
  • tag_name - The tag name associated with the release.
  • name - The name of the release.
  • body - The description or body content of the release.
  • draft - Indicates if the release is a draft.
  • prerelease - Indicates if the release is a prerelease.
  • target_commitish - The commitish value from which the Git tag is created.

Dependencies

  • GitHub API

Troubleshooting

  • Ensure the repository owner and repository name are correctly specified and accessible with the provided credentials.
  • Verify that the tag name is unique and valid according to GitHub's tagging conventions.
  • Check that the GitHub App credentials have the necessary permissions to create releases in the target repository.
  • Common error messages include authentication failures, invalid repository or owner names, and permission denied errors. Resolving these typically involves verifying credentials, repository access rights, and input correctness.

Links

Discussion