Releases are a great way to ship projects on GitHub to your users.

Note: Only users with write access to the repository can view drafts of releases. For more information, see:

  1. Repository tabOn your profile page, click the Repositories tab, then click the name of your repository.
  2. Releases in the headerIn the top header, click releases.
  3. Releases draft buttonClick Draft a new release.
  4. Releases tagged versionType a version number for your release. Versions are based on Git tags. We recommend naming tags that fit within semantic versioning.
  5. Releases tagged branchSelect a branch that contains the project you want to release. Usually, you'll want to release against your master branch, unless you're releasing beta software.
  6. Releases descriptionType a title and description that describes your release.
  7. Providing a DMG with the ReleaseIf you'd like to include binary files along with your release, such as compiled programs, drag and drop or select files manually in the binaries box.
  8. Marking it as a prereleaseIf the release is unstable, select This is a pre-release to notify users that it's not ready for production.
  9. Publish or draft release buttonsIf you're ready to publicize your release, click Publish release. Otherwise, click Save draft to work on it later.

Automatically creating releases

If you'd like to automatically create releases (either from the command line or in a script), check out our Releases API documentation.

Further reading