Who can use this feature?

Tip

If you have enabled immutable releases for your repository, it's recommended to create releases as drafts first, attach all assets, and then publish. This ensures all assets are in place before the release becomes immutable. For more information, seeImmutable releases.

1. On GitHub, navigate to the main page of the repository.

2. To the right of the list of files, clickReleases.

   

3. At the top of the page, clickDraft a new release.

4. To choose a tag for the release, select theChoose a tag dropdown menu.

   • To use an existing tag, click the tag.
   • To create a new tag, type a version number for your release, then clickCreate new tag.

5. If you created a new tag, select theTarget dropdown menu, then click the branch that contains the project you want to release.

6. Optionally, above the description field, select thePrevious tag dropdown menu, then click the tag that identifies the previous release.

   

7. In the "Release title" field, type a title for your release.

8. In the "Describe this release" field, type a description for your release.If you @mention anyone in the description, the published release will include aContributors section with an avatar list of all the mentioned users.Alternatively, you can automatically generate your release notes by clickingGenerate release notes.

9. Optionally, to include binary files such as compiled programs in your release, drag and drop or manually select files in the binaries box.

10. Optionally, to notify users that the release is not ready for production and may be unstable, selectThis is a pre-release.

11. Optionally, selectSet as latest release. If you do not select this option, the latest release label will automatically be assigned based on semantic versioning.

12. Optionally, if GitHub Discussions is enabled for the repository, create a discussion for the release.

    • SelectCreate a discussion for this release.
    • Select theCategory dropdown menu, then click a category for the release discussion.

13. If you're ready to publicize your release, clickPublish release. To work on the release later, clickSave draft. If you have enabled immutable releases for the repository, creating a draft first allows you to attach all assets before the release becomes immutable.You can then view your published or draft releases in the releases feed for your repository. For more information, seeViewing your repository's releases and tags.

1. To create a release, use thegh release create subcommand. Replacetag with the desired tag for the release.

   gh release create TAG

2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, seethe GitHub CLI manual. For example, this command creates a prerelease with the specified title and notes.

gh release create v1.3.2 --title "v1.3.2 (beta)" --notes "this is a public preview release" --prerelease

If you @mention any GitHub users in the notes, the published release will include aContributors section with an avatar list of all the mentioned users.

Note

If you have enabled immutable releases for your repository, you can only edit the title and release notes after a release is published. SeeImmutable releases.

1. On GitHub, navigate to the main page of the repository.

2. To the right of the list of files, clickReleases.

   

3. Next to the release you want to edit, click.

   

4. Edit the details for the release in the form, then clickUpdate release. If you add or remove any @mentions of GitHub users in the description, those users will be added or removed from the avatar list in theContributors section of the release.

1. To edit a release, use thegh release edit subcommand. ReplaceTAG with the tag representing the release you wish to edit. For example, to edit the title for a release, use the following code, replacingNEW-TITLE with the updated title:

   gh release edit TAG -t "NEW-TITLE"

   For more information about possible arguments, seethe GitHub CLI manual.

1. On GitHub, navigate to the main page of the repository.

2. To the right of the list of files, clickReleases.

   

3. On the right side of the page, next to the release you want to delete, click.

   

4. ClickDelete this release.

1. To delete a release, use thegh release delete subcommand. Replacetag with the tag of the release to delete. Use the-y flag to skip confirmation.

   gh release delete TAG -y