Skip to content

Commit e7ad469

Browse files
committed
SBCOSS-509: Updated Readme documentation for publishing to NPM
1 parent aeb693d commit e7ad469

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,4 +417,26 @@ The project maintains code quality through automated checks that run on every pu
417417
- Unit tests using Karma
418418
- Command: `npm run test`
419419

420-
These checks ensure consistent code style, secure dependency management, and reliable testing.
420+
These checks ensure consistent code style, secure dependency management, and reliable testing.
421+
422+
## Release Process
423+
424+
Release Process for Sunbird PDF Player - This GitHub Actions workflow automatically publishes the Sunbird PDF Player web component to NPM whenever a new tag is pushed. The following steps describe the workflow file:
425+
426+
- Checks out the repository code
427+
- Sets up Node.js
428+
- Manages dependency caching to speed up builds
429+
- Installs dependencies
430+
- Builds the web component
431+
- Packages and publishes it to NPM
432+
- Prerequisites - set the `NPM_TOKEN` in the repository secrets
433+
434+
1. **Web Component Publishing:**:
435+
- Builds the web component using `npm run build-web-component`
436+
- Packages it with specific version from package.json
437+
- Publishes to NPM as @project-sunbird/sunbird-pdf-player-web-component
438+
439+
2. **Module Publishing:**
440+
- Builds the main module using `npm run build-lib`
441+
- Packages it with specific version from package.json
442+
- Publishes to NPM as @project-sunbird/sunbird-pdf-player

0 commit comments

Comments
 (0)