Managing releases in a repository

You can create releases to bundle and deliver iterations of a project to users.

Repository collaborators and people with write access to a repository can create, edit, and delete a release.

About release management

You can also publish an action from a specific release in GitHub Marketplace. For more information, see "Publishing an action in the GitHub Marketplace."

You can choose whether Git Large File Storage (Git LFS) objects are included in the ZIP files and tarballs that GitHub creates for each release. For more information, see "Managing Git LFS objects in archives of your repository."

Creating a release

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

  2. To the right of the list of files, click Releases or Latest release. Releases section in right-hand sidebar

  3. Click Draft a new release. Releases draft button

  4. Click Choose a tag and type a version number for your release.

    Enter a tag

  5. Click Create new tag. Confirm you want to create a new tag

  6. Use the drop-down menu to select the branch that contains the project you want to release. Choose a branch

  7. Type a title and description for your release. Releases description

  8. Optionally, to include binary files such as compiled programs in your release, drag and drop or manually select files in the binaries box. Providing a DMG with the Release

  9. To notify users that the release is not ready for production and may be unstable, select This is a pre-release. Checkbox to mark a release as prerelease

  10. Optionally, select Create a discussion for this release, then select the Category drop-down menu and click a category for the release discussion. Checkbox to create a release discussion and drop-down menu to choose a category

  11. If you're ready to publicize your release, click Publish release. To work on the release later, click Save draft. Publish release and Draft release buttons

To learn more about GitHub CLI, see "About GitHub CLI."

  1. To create a release, use the gh release create subcommand. Replace tag 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, see the 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 beta release" --prerelease

Editing a release

  1. On GitHub, navigate to the main page of the repository.
  2. To the right of the list of files, click Releases or Latest release. Releases section in right-hand sidebar
  3. On the right side of the page, next to the release you want to edit, click Edit release. Edit a release
  4. Edit the details for the release in the form, then click Update release. Update a release

Releases cannot currently be edited with GitHub CLI.

Deleting a release

  1. On GitHub, navigate to the main page of the repository.
  2. To the right of the list of files, click Releases or Latest release. Releases section in right-hand sidebar
  3. Click the name of the release you wish to delete. Link to view release
  4. In the upper-right corner of the page, click Delete. Delete release button
  5. Click Delete this release. Confirm delete release
  1. To delete a release, use the gh release delete subcommand. Replace tag with the tag of the release to delete. Use the -y flag to skip confirmation.

    gh release delete tag -y

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.