|
1 | | -# New Workflows |
2 | | - |
3 | | -### Branches involved |
4 | | -***main***<br> |
5 | | -***feature/\*\*/\*\****<br> |
6 | | -***hotfix/\*\*/\*\****<br> |
7 | | - |
8 | | -## Feature: |
9 | | -__Note__: only one feature per version. |
10 | | -1. Create branch from main for the feature. |
11 | | -2. Every developer related to the feature works on this branch. |
12 | | -3. When they finish they push. |
13 | | -4. This push activates the DEV actions, generates the DEV images, and is automatically deployed to DEV environment. |
14 | | -5. When everything is tested, PR is made to main. |
15 | | -6. After this PR is approved, the QA actions are activated, and the QA images are generated. |
16 | | -7. QA is updated manually to see that everything works well. |
17 | | -11. If everything works well, merge to main activate RC actions and generate RC images. |
18 | | -12. After test on RC, create a new release that will activate release actions. |
19 | | - |
20 | | -## Hotfix |
21 | | -1. Create branch from main for the hotfix. |
22 | | -2. Every developer related to the hotfix works on this branch. |
23 | | -3. When they finish, they make a PR to main. |
24 | | -4. After this PR is merged to main, the rc actions are activated, and the rc images are generated. |
25 | | -5. RC is updated manually to see that everything works well and we test it in RC. |
26 | | -6. If everything works well, create a new release that will activate release actions. |
27 | | - |
28 | | - |
29 | | -### Actions |
30 | | -dev->on push ***feature/\*\*/\*\**** branch<br> |
31 | | -qa->on pull-request: approved main branch<br> |
32 | | -rc->on push: main branch<br> |
33 | | -release-> on release<br> |
| 1 | +# 🛠️ Multi-Environment Workflows – UTMStack |
| 2 | + |
| 3 | +> This repository uses a structured, version-based deployment system (`v10`, `v11`) across multiple environments: `dev`, `qa`, `rc`, and `prod`. |
| 4 | +> Each environment is triggered automatically based on branch patterns and workflow logic. |
| 5 | +
|
| 6 | + |
| 7 | + |
| 8 | +## 🌿 Branches Involved |
| 9 | + |
| 10 | +- `v10`, `v11` → Main version branches |
| 11 | +- `release/v10.x.x`, `release/v11.x.x` → Feature/bugfix integration branches |
| 12 | +- `hotfix/v10.x.x`, `hotfix/v11.x.x` → For urgent production fixes |
| 13 | +- `feature/...` → Optional; features are typically integrated into `release/*` branches |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## ✨ Feature Flow (per version) |
| 18 | + |
| 19 | +> Best used for planned feature development. |
| 20 | +
|
| 21 | +1. Developers work on shared integration branches: |
| 22 | + `release/v10.x.x` or `release/v11.x.x` |
| 23 | + |
| 24 | +2. On **push**, the `dev` workflow is triggered and deployed to: |
| 25 | + `v10-dev` or `v11-dev` |
| 26 | + |
| 27 | +3. Once stable, a **pull request is opened to `v10` or `v11`**, the `qa` workflow is triggered and deployed to: |
| 28 | + `v10-qa` or `v11-qa` |
| 29 | + |
| 30 | +5. After QA validation, the PR is **merged** into the base branch (`v10` or `v11`). |
| 31 | + |
| 32 | +6. This triggers deployment to the **RC environment**: |
| 33 | + `v10-rc` or `v11-rc` |
| 34 | + |
| 35 | +7. Once RC validation is complete, a **release tag (`v10.x.x` or `v11.x.x`)** is created to deploy to production. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## 🔥 Hotfix Flow (urgent patches) |
| 40 | + |
| 41 | +> Used for emergency fixes in production. |
| 42 | +
|
| 43 | +1. Create a branch: |
| 44 | + `hotfix/v10.x.x` or `hotfix/v11.x.x` from `v10` or `v11` |
| 45 | + |
| 46 | +2. After development, open a **PR to `v10` or `v11`** |
| 47 | + |
| 48 | +3. On merge, the `rc` workflow is triggered: |
| 49 | + `v10-rc` or `v11-rc` |
| 50 | + |
| 51 | +4. If the patch is valid, create a **release tag** to deploy to production. |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +## ⚙️ GitHub Actions Triggers |
| 56 | + |
| 57 | +| Environment | Trigger Condition | |
| 58 | +|-------------|-------------------| |
| 59 | +| `dev` | Push to `release/v10**` or `release/v11**` | |
| 60 | +| `qa` | Pull request to `v10` or `v11` from `release/v10**` or `release/v11**`, and approved | |
| 61 | +| `rc` | Push to `v10` or `v11` from `hotfix/*` or `release/*` | |
| 62 | +| `prod` | Push of a tag starting with `v10.` or `v11.` | |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +## 🚀 Releasing to Production |
| 67 | + |
| 68 | +A production deployment is triggered only by pushing a version tag: |
| 69 | + |
| 70 | +```bash |
| 71 | +git tag v10.5.0 |
| 72 | +git push origin v10.5.0 |
0 commit comments