This document describes the steps to release a new version of UDDF Swift.
- You have commit access to the repository
- You have push access to the repository
-
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
-
Update CHANGELOG.md
Move changes from
Unreleasedto a new release section following the Common Changelog format (see CONTRIBUTING.md for details):## X.Y.Z - YYYY-MM-DD ### Changed - Description of changes
-
Run tests and confirm they pass
swift test -
Build and confirm it compiles
swift build
-
Commit any pending changes
git add . git commit -m "Release $VERSION"
-
Create a tag
git tag -a v$VERSION -s -m "Release $VERSION"
-
Push the changes and tag
git push origin main git push origin v$VERSION
- Verify the new version appears on GitHub releases