Skip to content

Latest commit

 

History

History
133 lines (104 loc) · 2.98 KB

DEV_WORKFLOW.md

File metadata and controls

133 lines (104 loc) · 2.98 KB
Raw

Workflow

  1. main (branch) is always current;
  2. develop branch is always the "root" of new activity.

Branch Naming

  • FEATURE: ft. , eg. ft.kitchen-sink-option
  • HOTFIX: hf. , eg. hf.teflon-tape
  • RELEASE: rl. , eg. rl.1.2.3

New Feature

Start a new feature branch

git checkout -b ft.kitchen-sink-option develop

Work on new feature branch

git checkout ft.kitchen-sink-option
# WORK WORK WORK...
git commit --gpg-sign -m 'Add stuffs'
# WORK WORK WORK...
git commit --gpg-sign -m 'Add more stuffs'
# WORK WORK WORK...

Finish the feature - merge back into develop

git checkout ft.kitchen-sink-option
git rebase --interactive develop
# PICK first, SQUASH rest (generally)
git checkout develop
git merge --gpg-sign --no-ff ft.kitchen-sink-option
git push origin develop:develop
git push gitlab develop:develop
git push github develop:develop
# etc...
git branch -d ft.kitchen-sink-option

Hotfix

Start a new hotfix branch

git checkout -b hf.teflon-tape main
  • TODO: Will this allow us to hotfix previous versions?

Work on new hotfix branch

git checkout hf.teflon-tape
# WORK WORK WORK...
git commit --gpg-sign -m 'Add stuffs'
# WORK WORK WORK...
git commit --gpg-sign -m 'Add more stuffs'
# WORK WORK WORK...

Finish the hotfix - merge back into develop

git checkout hf.teflon-tape
# UPDATE Documentation for new hotfix etc
git add README.md
git commit --gpg-sign -m 'Hotfix: 1.0.1'
git tag -s -m 'HOTFIX: 1.0.1' 1.0.1
git checkout develop
git merge --gpg-sign hf.teflon-tape
git push --tags origin develop:develop
git push --tags gitlab develop:develop
git push --tags github develop:develop
# etc...
git branch -d hf.teflon-tape
git checkout main
git merge --ff-only 1.0.1

Release

Start a new release branch

git checkout -b rl.1.2.3 develop
# UPDATE Documentation for new version etc
git add README.md
git commit --gpg-sign -m 'Release: 1.2.3'
git tag -s -m 'RELEASE: 1.2.3' 1.2.3
git checkout develop
git merge --gpg-sign rl.1.2.3
git push --tags origin develop:develop
git push --tags gitlab develop:develop
git push --tags github develop:develop
# etc...
git branch -d rl.1.2.3
git checkout main
git merge --ff-only 1.2.3
git push origin master:master
make distclean
make ratslap-1.2.3.tar.gz.asc
rename tar tar.x86_64 ratslap*tar.gz*

Release on GitHub

git push github master:master

Edit releases page:

Release on GitLab

git push gitlab master:master

Edit releases page: