Skip to content

Release Management

Niclas Kristek edited this page May 17, 2022 · 1 revision

This document guides you through the process of creating a release of this library.

Table of Contents

Branches

The main branches of this repository are master and develop. Changes to the codebase are merged into the develop branch. For every release, develop is merged into master and the corresponding commit on master is then tagged with the respective version number.

Creating a Release

To start the creation process of a new release, a pull request has to be created to merge develop into master. The title for this pull request should be Release <VERSION> (replace the placeholder with the version number of the upcoming release). The version number follows Semantic Versioning 2.0.0.

Once this pull request is approved and merged, a release can be created here.

Create a new tag with the version of the release. Make sure to include all three numbers, meaning version 1.0 needs to be tagged as 1.0.0, otherwise SwiftPM fails to resolve the version.

Next, select master from the list of branches as the target of the release.

For the description, paste the name and number of each pull request that is included in the release. For example:

- SingleModelSectionController: Reload entire section when model is changed (#95)
Clone this wiki locally