Skip to content

Commit e7351b4

Browse files
committed
CL-1543 | Update README.md file
1 parent 61f93dd commit e7351b4

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,75 @@ Run cloud functions locally
3838
```
3939

4040
<!-- commandsstop -->
41+
42+
43+
44+
# How to test Changes Locally?
45+
- Branch out from development for development.
46+
- Install npm: @contentstack/cli
47+
- Set region and log in using csdx config:set:region & csdx login
48+
49+
`node bin/dev <command-name>`
50+
51+
OR
52+
53+
`npm run prepack`
54+
55+
56+
`node bin/run <command-name>`
57+
58+
OR
59+
60+
61+
```
62+
npm run prepack
63+
64+
csdx plugins:link <plugin local path>
65+
66+
csdx <command-name>
67+
```
68+
69+
70+
# Release & SRE Process:-
71+
72+
Version Increment:
73+
74+
Patch version update (fixes): 1.0.0 → 1.0.1
75+
76+
Minor version update (enhancements): 1.0.0 → 1.1.0
77+
78+
Major version update (breaking changes): 1.0.0 → 2.0.0
79+
80+
## For release:
81+
82+
- Raise a draft pull request (PR) from the development branch to the main branch.
83+
84+
### Pre-release SRE Preparation:
85+
86+
- Create an SRE ticket a week before the release date, including the PR.
87+
88+
- After the SRE review, address any identified issues and create tickets for any new issues.
89+
90+
- Request SRE approval if no issues are identified or after fixing all the SRE-raised issues.
91+
92+
### CAB Approval:
93+
94+
- For CAB, prepare deployment plan sheets(including publish & rollback plan).
95+
96+
- Once SRE approves, raise the request for CAB(SRE ticket, deployment plan, release tickets, release notes). At least two CAB approvals are required.
97+
98+
- Obtain approval for the PR from the security admin (Aravind) and launch admin.
99+
100+
### Merge and Release:
101+
102+
- 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.
103+
104+
105+
106+
### How will changes be reflected in the CLI ?
107+
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.
108+
`npm i -g @contentstack/cli`
109+
OR
110+
`npm update -g @contentstack/cli`
111+
112+
However, if a major version of the launch is released, a version bump is also required in CLI(Steps will be like this launch version bump -> cli version bump -> testing -> release).

0 commit comments

Comments
 (0)