jacob-mathison/doczyai-pipelines
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

v0tocomplete

Browse Source
This commit is contained in:
Michael McGuinness
2024-09-24 18:40:06 +01:00
parent c46ebcc6b5
commit 49aa245d10
1 changed files with 9 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+9 -41
View File
@@ -8,58 +8,26 @@ This guide outlines the naming conventions, branching strategy, and merging proc
### Feature Branches
- **Naming Convention**: `feature/<workstream>_<version>`
- Example: `feature/streamlit_UI0_1.0`, `feature/textract_1.5`
- **Naming Convention**: `feature/<name>`
- Example: `feature/add_build_stage`, `bugfix/pages_duplication`
## ....
## Branching Strategy
### Creating Feature Branches
### Creating Branches
1. **From Release Branch**: Create a feature branch from `release/uat_<version>`
- Example: To develop Streamlit UI1 v1.5, create `feature/streamlit_UI1_1.5` from `release/uat_1.0`
1. **From Main Branch**: Create a feature branch from `main`
### Merging Process
#### Merging to DEV
#### Merging to main
1. **Initial Merge**: Once the feature is ready, merge the feature branch into DEV.
1. **Initial Merge**: Once the feature is ready, merge the feature branch into main.
2. **Verification**: Ensure the functionality is verified in DEV.
#### Merging to UAT
1. **Approval Requirement**: Merge to UAT requires approval from default reviewers (Anup / Priya / Umang).
2. **Post-Approval Merge**: After approval, merge the same feature branch that was verified in DEV into UAT.
#### Merging to PROD
1. **Final Merge**: Once the feature is tested and approved in UAT, merge it into PROD.
2. **Complete Versions**: Deployment to PROD should only be done with complete versions (e.g., v1.0, v2.0) with an appropriate release branch in place.
## State of Branches
### After Initial Release (v1.0)
| Workstream | DEV | UAT | PROD |
|------------|-----|-----|------|
| Streamlit | 1.0 | 1.0 | 1.0 |
| Textract | 1.0 | 1.0 | 1.0 |
| DevOps | 1.0 | 1.0 | 1.0 |
| Data | 1.0 | 1.0 | 1.0 |
### After Streamlit 1.5 and Textract 1.5
| Workstream | DEV | UAT | PROD |
|------------|-----|-----|------|
| Streamlit | 1.5 | 1.5 | 1.0 |
| Textract | 1.5 | 1.5 | 1.0 |
| DevOps | 1.0 | 1.0 | 1.0 |
| Data | 1.0 | 1.0 | 1.0 |
## Merge Restrictions
- **Workstream Specific Changes**: For feature branches, only changes in the respective folder are allowed. Other changes require a separate feature branch. This ensures that workstream changes are deployed to the respective infra.
- **Merge Approval**: Merging into DEV, UAT or PROD requires approval from default reviewers.
## Refer to the branching guide in Confluence for more info on this
---
This guide ensures that all team members follow the best practices for branch management and releases.
This guide ensures that all team members follow the best practices for branch management and releases.