Files
my-app/README.md
2025-10-29 09:53:42 +01:00

70 lines
2.9 KiB
Markdown

# my-app
1. RELEASE BRANCH FOR MY_APP
2. PATCH (HOTFIX) RELEASES FOR MY_APP
# 1. RELEASE BRANCH FOR MY_APP
## Step 1: Update main/master branch, ensure both local and remote are same, to do so,
- `git checkout main`
- `git pull`
- `git pull --ff-only` (ignore)
## Step 2: Create a versioned release branch with pattern: release/v<major.minor.patch> e.g. release/v1.4.0 where 1.4.0 is the version to be released
- `git checkout -b release/v<major>.<minor>.<patch>`
## Step 3: Update the app version, commit and tag
- update the app version in:
1. _frontend/package.json_ manually
2. _frontend/package.json_ by running `yarn install` after 1. above
3. _src/build.gradle_ manually
4. _Swagger config_ manually
5. _Dockerfile_ manually
_env (only during image build & deployment)_ manually
- add changes
`git add .`
- commit changes
`git commit -m "Set version to v<major>.<minor>.<patch>"`
- push changes
`git push --set-upstream origin release/v<major>.<minor>.<patch>`
- Create and review the release pull request, then MERGE the release branch
`git merge --no-ff release/v<major>.<minor>.<patch> -m "Merge release v<major>.<minor>.<patch>"`.
- checkout and update main/master branch
`git checkout main/master` & `git pull origin main/master`
- Create tag with the version number (format is very important) `git tag v<major>.<minor>.<patch> -m "Release v<major>.<minor>.<patch>"`
- Push tag
`git push origin v<major>.<minor>.<patch>`
- Create a GitHub Release from the tag - (from UI)
# 2. PATCH (hotfix) RELEASES FOR MY_APP
## Step 1: Update main/master branch, ensure both local and remote are same, to do so,
- `git checkout main`
- `git pull`
## Step 2: Create a versioned hotfix branch with pattern: hotfix/v<major.minor.patch> e.g. hotfix/v1.4.1 where 1.4.1 is the hotfix version to be released
- `git checkout -b hotfix/v<major>.<minor>.<patch>`
## Step 3: Update the app version, commit and tag
- update the app version in:
1. _frontend/package.json_ manually
2. _frontend/package.json_ by running `yarn install` after 1. above
3. _src/build.gradle_ manually
4. _Swagger config_ manually
5. _Dockerfile_ manually
_env (only during image build & deployment)_ manually
- add changes `git add .`
- commit changes `git commit -m "Set hotfix to v<major>.<minor>.<patch>"`
- push chnages `git push --set-upstream origin hotfix/v<major>.<minor>.<patch>`
- Create and review the hotfix pull request, then MERGE the hotfix branch `git merge --no-ff hotfix/v<major>.<minor>.<patch> -m "Merge hotfix v<major>.<minor>.<patch>"`.
- checkout and update main/master branch `git checkout main/master` & `git pull origin main/master`
- Create tag with the hotfix version number (format is very important) `git tag v<major>.<minor>.<patch> -m "Hotfix v<major>.<minor>.<patch>"`
- Push tag `git push origin v<major>.<minor>.<patch>`
- Create a GitHub Release from the tag - (from UI)