Skip to content

Commit 205774b

Browse files
rf-opssupportrf-opssupport
authored
Feature/doc (#103)
* Create release_flow.md * Update release_flow.md * Create REAN_Platform_Deployment_Workflows.md * Update README.md * Update README.md * Updated doc * Update release_flow.md removed the sub headings from the release workflow to avoid duplication
1 parent 0eed98c commit 205774b

File tree

3 files changed

+164
-0
lines changed

3 files changed

+164
-0
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This service supports following workflows.
1111
### Highlights
1212
- API currently supports client authentication using API keys.
1313
- User authentication is also applicable for careplan and asset creators and admin.
14+
15+
* [Release Flow](docs/release_flow.md)
1416

1517
### Currently in progress
1618
- Careplan service supports static careplan schedules, but support for dynamic scheduling of careplans is in progress. When complete, the scheduling will be driven by rule engine, events and participant responses.

‎docs/release_docs/REAN_Platform_Deployment_Workflows.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# REAN Platform Deployment Workflows
2+
3+
## PR-CI-CD
4+
5+
**Mode of Trigger:** Automated
6+
7+
The PR Workflow is triggered automatically whenever a Pull Request with a source branch as a `feature/*` branch is created against the target branch as the `develop` branch.
8+
9+
### PR Workflow Diagram
10+
![PR-ci-cd_workflow](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/pr-ci-cd_workflow.png?raw=true)
11+
12+
### GitHub Action Workflow Run
13+
![pr](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/Pr-ci-cd_example.png?raw=true)
14+
15+
### Jobs
16+
17+
The PR workflow employs two jobs:
18+
19+
#### CodeScan-ESLint
20+
In this job, we analyze the code that the developer wrote against certain rules to identify any stylistic or programmatic errors.
21+
* This job uses the [Super-linter](https://github.com/marketplace/actions/super-linter) action.
22+
* It utilizes a static code analysis tool to detect problematic patterns within the application's source code.
23+
24+
#### Build-Docker-Image
25+
In this job, we validate the Dockerfile and test the image build process to uncover any issues arising from recent code changes.
26+
* This job uses [docker/build-push-action](https://github.com/marketplace/actions/build-and-push-docker-images).
27+
* It generates a Docker image with an image tag using the branch name and the short SHA of the commit, such as `feature/test_5e38e33`.
28+
29+
## Dev-CI-CD
30+
31+
**Mode of Trigger:** Automated
32+
33+
The Dev Workflow is automatically initiated whenever a Pull Request is merged into the `develop` branch. This workflow encompasses building the applications and deploying the changes to the RF Platform Development environment.
34+
35+
### Dev Workflow Diagram
36+
![Dev-ci-cd_workflow](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/dev-ci-cd_workflow.png?raw=true)
37+
38+
### GitHub Action Workflow Run
39+
![dev](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/Dev-ci-cd_example.png?raw=true)
40+
41+
### Jobs
42+
43+
#### Deploy-ECS
44+
The Deploy ECS job encompasses the following steps:
45+
46+
* It utilizes [docker/build-push-action](https://github.com/marketplace/actions/build-and-push-docker-images).
47+
* This job functions within the 'dev' environment and logs into ECR using credentials. It then constructs a new ECR Docker image with an image tag derived from the branch name and the short SHA of the commit. For instance, `/careplan-service-dev-uat:develop_5e38e33`.
48+
* Subsequently, the job generates a fresh version of the Amazon ECS task definition, integrating the new Docker image. The deployment of the Amazon ECS task definition is orchestrated using the Duplo API.
49+
50+
## UAT-CI-CD
51+
52+
**Mode of Trigger:** Automated
53+
54+
The UAT-CI-CD workflow can be activated through two methods:
55+
56+
1. Creating a Pull Request to merge into the `MAIN` branch.
57+
2. Initiating a Pull Request from a branch prefixed with 'release/'.
58+
59+
### UAT Workflow Diagram
60+
![uat-ci-cd_Workflow](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/uat-ci-cd_workflow.png?raw=true)
61+
62+
### GitHub Action Workflow Run
63+
![uat](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/Uat-ci-cd_example.png?raw=true)
64+
65+
### Jobs
66+
67+
#### CodeScan-ESLint
68+
The CodeScan ESLint job executes the following steps:
69+
70+
* It employs the [Super-linter](https://github.com/marketplace/actions/super-linter) action.
71+
* Utilizing a static code analysis tool, this job identifies problematic patterns present in the application's source code.
72+
73+
#### Label_Checks
74+
The Label Checks job performs the subsequent actions:
75+
76+
* It leverages [pull-request-label-checker](https://github.com/marketplace/actions/label-checker-for-pull-requests).
77+
* Upon a Pull Request event, the job assesses whether the Pull Request bears one of the major, minor, or patch labels.
78+
79+
#### Deploy-ECS
80+
The Deploy ECS job encompasses the ensuing steps:
81+
82+
* It employs [docker/build-push-action](https://github.com/marketplace/actions/build-and-push-docker-images).
83+
* This job operates within the 'UAT' environment and authenticates to ECR using credentials. It proceeds to build a fresh ECR Docker image accompanied by an image tag derived from the branch name and the short SHA of the commit, such as `/careplan-service-dev-uat:develop_5e38e33`.
84+
* Subsequently, the job generates a new version of the Amazon ECS task definition, incorporating the updated Docker image. The deployment of the Amazon ECS task definition is facilitated using the Duplo API.
85+
86+
## PROD-CI-CD
87+
88+
**Mode of Trigger:** Automated
89+
90+
The Prod Workflow is automatically initiated whenever a Pull Request is merged into the main branch. This workflow encompasses building the applications and deploying the changes to the RF Platform Production environment.
91+
92+
### Prod Workflow Diagram
93+
![prod-ci-cd_Workflow](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/PROD-ci-cd_workflow.png?raw=true)
94+
95+
### GitHub Action Workflow Run
96+
![prod](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/prod-ci-cd_example.png?raw=true)
97+
98+
### Jobs
99+
100+
#### Publish-Release
101+
The Publish-Release job undertakes the ensuing actions:
102+
103+
* It utilizes [release-drafter](https://github.com/release-drafter/release-drafter).
104+
* This job generates a new GitHub release, with the versioning based on the label assigned by the developer to the pull request.
105+
106+
#### Deploy-ECS
107+
The Deploy-ECS job encompasses the following steps:
108+
109+
* It employs [docker/build-push-action](https://github.com/marketplace/actions/build-and-push-docker-images).
110+
* This job authenticates to ECR using credentials and assembles a new ECR Docker image accompanied by an image tag based on the ID of the release generated by the Publish-Release job. For instance, `careplan-service-dev-uat:97777323`.
111+
* Subsequently, the job produces a new version of the Amazon ECS task definition, integrating the updated Docker image. The deployment of the Amazon ECS task definition is facilitated using the Duplo API.

‎docs/release_flow.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# About Release Flow
2+
3+
1. For general guidance about using GitHub actions, you can take a look at [Github Actions Guide](https://docs.github.com/en/actions/guides).
4+
2. We have a total of 7 active release workflows. These are located under [Workflows](https://github.com/REAN-Foundation/reancare-service/tree/develop/.github/workflows).
5+
6+
## Table Of Contents
7+
- [Branching Strategy](#Branching-Strategy)
8+
- [Develop to Main Branch Workflow](#Develop-to-Main-branch-Workflow)
9+
- [Develop Branch Workflow](#Develop-Branch-Workflow)
10+
- [Main branch Workflow](#Main-branch-Workflow)
11+
- [Release Workflows](#Release-Workflows)
12+
- [REAN Foundation Platform Workflows](#REAN-Foundation-Platform-Workflows)
13+
14+
15+
## Branching Strategy
16+
17+
We are following the GitFlow branching strategy. Please refer [here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
18+
19+
* ```main```: The main branch serves as the stable and production-ready branch, where all the changes from release branches are merged and tested before deployment.
20+
* ```develop```: The develop branch, where all the changes from feature branches are merged
21+
* ``` feature/*```: The feature branch, individual features, or enhancements are developed on separate branches, allowing for isolated development and easy collaboration before merging.
22+
* ```release/*```: The release branch is a branch used for allowing isolated testing and preparation of the release before merging it into the main branch.
23+
* ```hotfix/*```: The hotfix branch, hotfixes for critical issues are handled separately by creating dedicated branches and merging them directly into the main branch.
24+
25+
## Develop to Main Branch Workflow
26+
27+
The diagram below explains the end-to-end process and stages for promoting the code from the develop branch to the master branch.
28+
29+
![workflow_diagram](https://github.com/REAN-Foundation/reancare-service/blob/develop/assets/images/workflow_diagram.png?raw=true)
30+
31+
### Develop Branch Workflow
32+
33+
1. The developer will create a Feature branch and a Pull Request to develop the branch, triggering the PR-ci-cd workflow.
34+
2. After the Pull request merges into develop branch it will Trigger the DEV-ci-cd workflow.
35+
36+
### Main branch Workflow
37+
38+
1. The developer will create a Release branch and a Pull Request to the main branch, triggering the UAT-ci-cd workflow.
39+
2. After the Pull request merges into the main branch it will trigger the PROD-ci-cd workflow.
40+
41+
# Release Workflows
42+
43+
There are different types of workflows designed for the type of source branch used based on the GitFlow workflow and the deployment targets as explained below
44+
45+
### REAN Foundation Platform Workflows
46+
47+
* [PR-CI-CD](https://github.com/REAN-Foundation/reancare-service/blob/develop/docs/release_docs/REAN_Platform_Deployment_Workflows.md#pr-ci-cd)
48+
* [Dev-CI-CD](https://github.com/REAN-Foundation/reancare-service/blob/develop/docs/release_docs/REAN_Platform_Deployment_Workflows.md#dev-ci-cd).
49+
* [UAT-CI-CD](https://github.com/REAN-Foundation/reancare-service/blob/develop/docs/release_docs/REAN_Platform_Deployment_Workflows.md#uat-ci-cd).
50+
* [PROD-CI-CD](https://github.com/REAN-Foundation/reancare-service/blob/develop/docs/release_docs/REAN_Platform_Deployment_Workflows.md#prod-ci-cd).
51+

0 commit comments

Comments
 (0)