Skip to content

#SBCOSS-522-workflow to publish pacakge to npm #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pallakartheekreddy merged 2 commits into from
Jun 17, 2025
Merged

#SBCOSS-522-workflow to publish pacakge to npm #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6959ba
SBCOSS-522: updated workflow
Rakshitha-D Jun 17, 2025
93b7a3f
SBCOSS-522: added readme
Rakshitha-D Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/pull_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ jobs:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
with:
args: >
-Dsonar.projectKey=project-sunbird_sunbird-content-player
-Dsonar.organization=project-sunbird
-Dsonar.projectKey=Sunbird-Knowlg_sunbird-content-player
-Dsonar.organization=sunbird-knowlg-1
-Dsonar.sources=.
-Dsonar.host.url=https://sonarcloud.io
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,39 @@ We use [SemVer](https://semver.org/) for versioning. For the versions available,
## Any Issues ?
We have an open and active [issue tracker](https://github.com/Field-Issues/issues). Please report any issues.

## Code Quality

The project maintains code quality through automated checks that run on every pull request:

1. **Dependencies**
- Uses `npm i --legacy-peer-deps` for installation
- GitHub Actions cache for faster builds

2. **Testing**
- Unit tests using Karma
- Command: `npm run test`

3. **Code Analysis**
- SonarCloud integration for code quality metrics
- Analyzes:
- Code quality
- Test coverage
- Code duplications
- Security vulnerabilities

These checks ensure consistent code style, secure dependency management, and reliable testing.

## Package Publishing

Workflow automatically builds and publishes NPM packages whenever a new tag is pushed to the repository.

### Publish Workflow

The workflow is triggered on:
- push of any tag

Key features of the workflow:
1. Automatically builds the project
2. Creates NPM package
3. Publishes to NPM registry as @project-sunbird/sunbird-collection-editor-web-component, using NPM authentication token (must be provided as GitHub secret `NPM_TOKEN`)

Loading