Skip to main content

Managing releases in a repository

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

Who can use this feature

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

About release management

You can create new releases with release notes, @mentions of contributors, and links to binary files, as well as edit or delete existing releases. You can also create, modify, and delete releases by using the Releases API. For more information, see "Releases" in the REST API documentation.

Creating a release

  1. On your enterprise, navigate to the main page of the repository.

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

  3. Click Draft a new release.

    Releases draft button

  4. Click Choose a tag, type a version number for your release, and press Enter. Alternatively, select an existing tag.

    Enter a tag

  5. If you are creating a new tag, click Create new tag.

    Screenshot of confirming you want to create a new tag

  6. If you have created a new tag, use the drop-down menu to select the branch that contains the project you want to release.

    Screenshot of dropdown to choose a branch

  7. Type a title and description for your release. If you @mention anyone in the description, the published release will include a Contributors section with an avatar list of all the mentioned users.

Screenshot of the releases description

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

    Animated GIF of Providing a DMG with the Release

  2. To notify users that the release is not ready for production and may be unstable, select This is a pre-release.

    Screenshot of the checkbox to mark a release as prerelease

  3. 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 You can then view your published or draft releases in the releases feed for your repository. For more information, see "Screenshot of your repository's releases and tags."

    Published release with @mentioned contributors

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

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

Editing a release

  1. On your enterprise, navigate to the main page of the repository.

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

  3. On the right side of the page, next to the release you want to edit, click . Edit a release

  4. Edit the details for the release in the form, then click Update 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 the Contributors section of the release. Update a release

Releases cannot currently be edited with GitHub CLI.

Deleting a release

  1. On your enterprise, navigate to the main page of the repository.

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

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

  4. 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