Branching and Releasing - leboncoin/spark-ios GitHub Wiki

Branching

The master branch is main. This branch should always build and be deployable at any time.

When starting a new component or feature, create a new branch for that component using the naming convention: feature\[Component Name].

To avoid having very large PR's, single tasks of building a new component should be branched from this feature branch and the PR made against this feature branch.

The separate task branches of a feature need not be complete, but should compile and build. The task branches should have a similar name to the feature branch: feature\[Component Name]\[Task name].

When the feature is complete, i.e. all the tasks are completed and the PRs have been merged back to the main feature branch, a PR of the feature branch should be created against main.

Steps to Create a Release

Create the release using the release feature in github.

  1. Click on Draft a new release
  2. Click on Choose a tag a create a new tag*** X.Y.Z
  3. Add a description of the changes and the link of wiki for the component (if needed), and also the release note (Click on Generate release note)
  4. Check only on Set as the latest release case and uncheck the others
  5. Final step, click on Publish release