Skip to content

Commit 5e4d2d8

Browse files
committed
update: update README file with steps to run tests locally
1 parent ea8abc4 commit 5e4d2d8

File tree

1 file changed

+6
-38
lines changed

1 file changed

+6
-38
lines changed

README.md

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ With Launch CLI, you can interact with the Contentstack Launch platform using th
88
* [Launch CLI plugin](#launch-cli-plugin)
99
* [Installation steps](#installation-steps)
1010
* [Commands](#commands)
11-
* [How to test Changes Locally?](#how-to-test-changes-locally)
12-
* [Release & SRE Process:-](#release--sre-process-)
11+
* [How to do development Locally?](#how-to-do-development-locally)
12+
* [How to run tests Locally?](#how-to-run-tests-locally)
1313
<!-- tocstop -->
1414

1515
# Installation steps
@@ -43,7 +43,7 @@ Run cloud functions locally
4343

4444

4545

46-
# How to test Changes Locally?
46+
# How to do development Locally?
4747
- Branch out from development for development.
4848
- Install npm: @contentstack/cli
4949
- Set region and log in using csdx config:set:region & csdx login
@@ -70,46 +70,14 @@ csdx <command-name>
7070

7171
# How to run tests Locally?
7272
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:
8973

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
10575

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)
10777

108-
### Merge and Release:
78+
Step 4:- run test cases (`npm run test:unit` or `npm run test:unit:report`)
10979

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.
11180

112-
11381

11482
### How will changes be reflected in the CLI ?
11583
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

Comments
 (0)