You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[How to do development Locally?](#how-to-do-development-locally)
12
+
*[How to run tests Locally?](#how-to-run-tests-locally)
13
13
<!-- tocstop -->
14
14
15
15
# Installation steps
@@ -43,7 +43,7 @@ Run cloud functions locally
43
43
44
44
45
45
46
-
# How to test Changes Locally?
46
+
# How to do development Locally?
47
47
- Branch out from development for development.
48
48
- Install npm: @contentstack/cli
49
49
- Set region and log in using csdx config:set:region & csdx login
@@ -70,46 +70,14 @@ csdx <command-name>
70
70
71
71
# How to run tests Locally?
72
72
Step 1:- csdx config:set:region <region> Mentioned project should exists in provided org
73
-
Step 2:- csdx login
74
-
Step 3:- Create env on root level (refer: example.env file)
75
-
Step 4:- run test cases (`npm run test:unit` or `npm run test:unit:report`)
76
-
77
-
78
-
# Release & SRE Process:-
79
-
80
-
Version Increment:
81
-
82
-
Patch version update (fixes): 1.0.0 → 1.0.1
83
-
84
-
Minor version update (enhancements): 1.0.0 → 1.1.0
85
-
86
-
Major version update (breaking changes): 1.0.0 → 2.0.0
87
-
88
-
## For release:
89
73
90
-
- Raise a draft pull request (PR) from the development branch to the main branch.
91
-
92
-
### Pre-release SRE Preparation:
93
-
94
-
- Create an SRE ticket a week before the release date, including the PR.
95
-
96
-
- After the SRE review, address any identified issues and create tickets for any new issues.
97
-
98
-
- Request SRE approval if no issues are identified or after fixing all the SRE-raised issues.
99
-
100
-
### CAB Approval:
101
-
102
-
- For CAB, prepare deployment plan sheets(including publish & rollback plan).
103
-
104
-
- Once SRE approves, raise the request for CAB(SRE ticket, deployment plan, release tickets, release notes). At least two CAB approvals are required.
74
+
Step 2:- csdx login
105
75
106
-
- Obtain approval for the PR from the security admin (Aravind) and launch admin.
76
+
Step 3:- Create env on root level (refer: example.env file)
107
77
108
-
### Merge and Release:
78
+
Step 4:- run test cases (`npm run test:unit` or `npm run test:unit:report`)
109
79
110
-
- After getting the necessary approvals, merge the PR. This will trigger the publishing process on npm and GitHub, which can be tracked through the actions & github released tags.
111
80
112
-
113
81
114
82
### How will changes be reflected in the CLI ?
115
83
If a patch or minor version of the launch is released, users will need to update or install the latest CLI version, which will automatically include the latest launch version.
0 commit comments