Skip to content

Commit ecd157f

Browse files
committed
SBCOSS-511: updated readme file
1 parent 01b95ed commit ecd157f

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -721,4 +721,40 @@ Click to see the input data - [playerConfig](README.md#step-4-send-input-to-rend
721721

722722
Click to see the sample code - [sampleCode](https://github.com/Sunbird-Ed/SunbirdEd-mobile-app/blob/release-4.8.0/src/app/player/player.page.html)
723723

724-
<br /><br />
724+
<br /><br />
725+
726+
### Code Quality
727+
728+
The project maintains code quality through automated checks that run on every pull request:
729+
730+
1. **Linting**
731+
- Runs ESLint to check code style and quality
732+
- Command: `npm run lint`
733+
734+
2. **Dependencies**
735+
- Uses `npm i --legacy-peer-deps` for deterministic installations
736+
- GitHub Actions cache for faster builds
737+
738+
3. **Code Formatting**
739+
- Ensures consistent code formatting
740+
- Can be automatically fixed using `npm run lint:fix`
741+
742+
4. **Testing**
743+
- Unit tests using Karma
744+
- Command: `npm run test`
745+
746+
These checks ensure consistent code style and secure dependency management.
747+
748+
### Package Publishing
749+
750+
The project has two automated publishing workflows which build and publishes NPM packages whenever a new tag is pushed to the repository.
751+
752+
1. **Angular Module**
753+
- Builds package with `npm run build-lib`
754+
- Creates NPM package
755+
- Publishes to NPM registry as @project-sunbird/sunbird-video-player-v9, using NPM authentication token (must be provided as GitHub secret `NPM_TOKEN`)
756+
757+
2. **Web Component**
758+
- Builds package with `npm run build-web-component`
759+
- Creates NPM package
760+
- Publishes to NPM registry as @project-sunbird/sunbird-video-player-web-component, using NPM authentication token (must be provided as GitHub secret `NPM_TOKEN`)

0 commit comments

Comments
 (0)