Recently, I have developed a gitLab-based collaboration specification for release (non-continuous integration) based on Git-Flow, which can be used as a reference.

Branch specification

We have the following branches:

  1. Master: All stables on the master are production-ready.
  2. Develop: As the main branch of development, all The Mrs Should be merged into the Develop branch and periodically merged into master releases.
  3. Release -* : LTS versions need to have separate branches for subsequent (in case) hotfixes, down to minor versions such as release-v1.2, which are long-held branches.
  4. Feature /* : All new features (such as new features and performance optimizations) should checkout to a new feature branch first.
  5. Bugfix /* : A bugfix branch, which must be merged into the Develop branch only.
  6. Test /* : The test branch does three things: 1. 2. Modify the store-level configuration file (for example,.gitlab-ci.yml). 3. Used to host one-off tests (outside develop).
  7. Hotfix /* : The branch used to publish hotfixes, see the next section.
  8. Release /* : a branch used to do release work (e.g., update version numbers, bugfix), and also to freeze the feature, as shown in the next section.

Branch names should be named with underscores. The branch name will be forcibly checked in CI and fail if it is not compliant. The test/* branch is also set aside to support testing work that can pass CI checks.

Collaborative process

The development process

  1. First, make sure you’re on the Develop branch;
  2. Git checkout -b feature/your_feature;
  3. After development is complete, push to Origin;
  4. Select Mr, target Branch as Develop and check the bottom two options:

5. Wait for review to pass and click Merge. Check that Squash and Delete branch are checked again:6. If the merge request has a description, click “Modify Commit message” and click include Description at the bottom, then click merge:7. Done.

Bugfix process

Develop the bugfix

  1. First, make sure you’re on the Develop branch;
  2. Git checkout -b bugfix/your_bugfix;
  3. After development is complete, push to Origin;
  4. Select Mr, Target branch as Develop, and check the bottom two options as in the development process.
  5. After review passes, click Merge. Check that Squash and Delete Branch are checked again.
  6. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  7. Done.

Bugfix release / *

There is no need to merge directly back to Develop because release/* will eventually merge back to Develop.

  1. First, make sure you’re on the Release/vx.y.z branch;
  2. Git checkout -b bugfix/your_bugfix;
  3. After development is complete, push to Origin;
  4. Select Mr, Target branch as Release/vx.y.z, and check the bottom two options as in the development process.
  5. After review passes, click Merge. Check that Squash and Delete Branch are checked again.
  6. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  7. Done.

Hotfix process

You need to merge into Develop

  1. Follow the normal Bugfix process and update the version number in your code (in case you forget to merge back to Develop after merging to master).
  2. Switch to the master branch;
  3. Git checkout -b hotfix/your_hotfix;
  4. Cherry-pick bugfix commit;
  5. After checking, push to Origin;
  6. Select Mr, Target Branch as master, and check the bottom two options as in the development process.
  7. After review passes, click Merge. Check that Squash and Delete Branch are checked again.
  8. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  9. Go to the Master branch and type a new tag;
  10. Done.

You just merge into the master

This works if the bug you need to fix no longer exists on the Develop branch.

Updates to the version number do not need to be synchronized to Develop; conflicts can be resolved during the next merge.

  1. First, make sure you’re on the Master branch;
  2. Git checkout -b hotfix/your_hotfix;
  3. After the fix is complete, add a separate COMMIT, update the version number in the code, push to Origin;
  4. Select Mr, Target Branch as master, and check the bottom two options as in the development process.
  5. After review passes, click Merge. Check that Squash and Delete Branch are checked again.
  6. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  7. Go to the Master branch and type a new tag;
  8. Add the separate Commit cherry-pick from Step 3 to the Develop branch with the updated version number;
  9. Done.

You need to merge into LTS Release Branch

  1. Depending on the situation, the completion needs to be merged into Develop or just one of the master;
  2. Switch to the release-vx. Y branch (the branch to be fixed);
  3. Git checkout -b hotfix/your_hotfix;
  4. Cherry-pick hotfix commit;
  5. Update the version number in the code, check it and push it to Origin;
  6. Select Mr, target branch as release-vx. Y, and check the bottom two options as in the development process.
  7. After review passes, click Merge. Check that Squash and Delete Branch are checked again.
  8. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  9. Switch to the release-vx. Y branch and type a tag;
  10. Done.

Release process

The release process is quite special, which is quite different from other processes. Please pay attention to details.

The reason for doing this is that if you merge the Release Branch into the Develop branch and then merge the Develop branch into the master, There may be an unexpected commit (a new Mr Is merged into Develop during a collating release).

  1. First, make sure you’re on the Develop branch;
  2. Git checkout -b release/ vx.y.z;
  3. Do some work required for release (update version number, etc.);
  4. When you’re done, push to Origin;
  5. If Mr, target branch is master, squash and remove source branch are not checked **.
  6. After review passes, click Merge. Check that Squash and Delete Branch are not selected.
  7. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  8. Switch to Master and type a vx.y.z tag.
  9. Target branch = develop, ** uncheck squash, check Remove source branch**;
  10. After review passes, click Merge to check that Squash is not checked, but Delete Branch is checked.
  11. If the merge request has a description, click “Modify Commit Message” and click include Description at the bottom, then click Merge.
  12. Done.

CI check script

#!/usr/bin/env bash

echo "branch name is: $1"
if[[! $1 =~ ^(((feature|bugfix|test|hotfix)/.+)|(master|develop)|(release-v[0-9] + \.0-9]+)|(release/v[0-9] + \.0-9] + \.0-9]+(-[a-z0-9.]+(\+[a-z0-9.] +)? ?). ) $]]; then echo"branch name invalid!"> &2
  exit 1
fi
Copy the code