Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 1.35 KB

File metadata and controls

68 lines (44 loc) · 1.35 KB

Releasing

This document describes the steps to release a new version of UDDF Swift.

Prerequisites

  • You have commit access to the repository
  • You have push access to the repository

Release process

  1. Determine the new version using Semantic Versioning

    VERSION=0.X.0
    • MAJOR version for incompatible API changes
    • MINOR version for backwards-compatible functionality additions
    • PATCH version for backwards-compatible bug fixes
  2. Update CHANGELOG.md

    Move changes from Unreleased to a new release section following the Common Changelog format (see CONTRIBUTING.md for details):

    ## X.Y.Z - YYYY-MM-DD
    
    ### Changed
    
    - Description of changes
  3. Run tests and confirm they pass

    swift test
  4. Build and confirm it compiles

    swift build
  5. Commit any pending changes

    git add .
    git commit -m "Release $VERSION"
  6. Create a tag

    git tag -a v$VERSION -s -m "Release $VERSION"
  7. Push the changes and tag

    git push origin main
    git push origin v$VERSION

Post-release