Skip to content

Latest commit

 

History

History
16 lines (14 loc) · 891 Bytes

RELEASING.md

File metadata and controls

16 lines (14 loc) · 891 Bytes
Raw

Releasing a New Version

For project maintainers.

  1. Before committing to a release...
    1. Check the issue queue for critical issues.
    2. Search the codebase for important @todo comments.
  2. Create a release tag with Gitflow:
    1. Make sure local develop and main branches are current with upstream.
    2. Choose a semantic version number (x.y.z).
    3. Start the release with git flow release start x.y.z.
    4. Finish the release with git flow release finish x.y.z.
    5. Push the release tag to GitHub along with the updated develop and main branches.
  3. Create a GitHub release.
    1. Set the tag version and release title both to the new version number.
    2. Use the changelog for the description.