# Git branching workflow

For development ASGARDEX we follow [OneFlow approach](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow), which based on [GitFlow considered harmful](https://www.endoflineblog.com/gitflow-considered-harmful) article by [Adam Ruka](https://www.endoflineblog.com).

## TL;DR

- `develop` branch for development
- `release/{version}` branches are created from `develop`. It will be finalized by creating a new tag (semver based). Changes are merged back into `develop`.
- `hotfix/{version}` branches are created from latest tag. It will be finalized by creating a new tag (semver based). Changes are merged back into `develop`.
- Naming conventions for branches (`release/{version}` or `hotfix/{version}`) are important! These are needed to trigger actions for Electron builds (defined in `.github/workflows/build.yml`).

## Development

Main branch for development is `develop`

## Feature

### Create `feature` branch

To add new features, create a feature branch and name it based on issue number `issue-xyz/description`

Example:

```bash
git checkout -b issue-123/example develop
```

### Update `develop` branch

Open a PR to review at GitHub and squash merge changes after that into `develop` or as following:

```bash
git checkout develop
git merge --squash issue-123/example
git push
git branch -D issue-123/example
```

## Release

### Create `release` branch

To open a release, create a release branch (name it `release/{version}`) and push it to repository

Example:

```bash
git checkout -b release/v1.41.5
git push --set-upstream origin release/v1.41.5
```

If needed, open a PR for reviewing changes.

Prepare a draft release as described in [RELEASE.md](./RELEASE.md) and point it to latest release branch you have created before. By publishing the release GitHub will create a tag for you.

### Update `develop` branch

After that, bring changes of release branch into `develop` by squash merging previous created PR or like following:

```bash
git checkout develop
git merge --squash release/v.0.0.5
git push
```

Delete release branch.

Example:

```bash
git branch -D release/v.0.0.5
git push origin --delete release/v.0.0.5
```

## Hotfix

### Create `hotfix` branch

To create a hotfix branch name it `hotfix/{version}`, checkout from latest `tag`.

Example:

```bash
git checkout -b hotfix/0.0.6 v0.0.5
```

Open a PR to review. Similar to any other release, prepare a draft release as described in [RELEASE.md](./RELEASE.md) and point it to this hotfix branch you have created before. By publishing the release Github will create a tag for you.

### Update `develop` branch

Squash merge hotfix back to develop in GitHub or as follow:

Example:

```bash
git checkout hotfix/0.0.6
git checkout develop
git merge --squash hotfix/0.0.6
git branch -d hotfix/2.3.1
```