Skip to content

Commit

Permalink
Merge pull request #66 from microsoft/BranchingDocs-patch-1
Browse files Browse the repository at this point in the history
Removing release branches from docs
  • Loading branch information
freddydk authored Mar 2, 2022
2 parents ffd40f7 + c651b9a commit 140b6cc
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions Scenarios/BranchingStrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,6 @@ CI/CD workflow also runs when a pull request is merged to main branch. Use the a

Read more about use of feature branches and pull requests here https://docs.microsoft.com/en-us/azure/devops/repos/git/git-branching-guidance?view=azure-devops#keep-your-branch-strategy-simple

###Use release branches###
Release branches help you to stabilize your changes and give you more control on the code used in different environments. This branch is long-lived and **isn't merged back into the main branch in a pull request**, unlike the feature branches. Create as many release branches as you need or if you need to keep it simple create one. Keep in mind that each active release branch represents another version of the code you need to support. Lock release branches when you're ready to stop supporting a particular release.

AL-Go system supports release branches with the following format "releases/<release name>" e.g., releases/19.2. A CI/CD will be run when a change is pushed to a release branch.

A simple solution is to create a release from the latest or a given build from main or a release branch. Do not use a feature branch to create a release. For a more advanced scenario create prerelease and then promote it to a release.

If you decide not to have release branches, you can create a release from main, make sure that changes in main are always tested before getting merged and keep a high quality, up-to-date main branch.

Read more about release branches here https://docs.microsoft.com/en-us/azure/devops/repos/git/git-branching-guidance?view=azure-devops#use-release-branches

####Hotfixing an issue in a release####

The best approach to fix an issue in a release branch is to start by fixing/testing it in main.

Then you can create a pull request by cherry picking the changes and merge it to a release branch. A release can be created from the artifacts generated by CI/CD when changes are pushed to a release branch. If you have multiple release branches, repeat the same process for each release branch.

**Useful links**
Read more about flow and some of the basic terminology here https://docs.microsoft.com/en-us/devops/develop/how-microsoft-develops-devops

Expand All @@ -43,3 +26,4 @@ Here you can find useful information about branching patterns and anti-patterns

---
[back](/README.md)

0 comments on commit 140b6cc

Please sign in to comment.