Skip to content

SBCOSS-509: Updated Readme documentation for publishing to NPM#129

Merged
HarishGangula merged 1 commit intoSunbird-Knowlg:release-8.0.0from
Deeksha1502:update-readme
Jun 4, 2025
Merged

SBCOSS-509: Updated Readme documentation for publishing to NPM#129
HarishGangula merged 1 commit intoSunbird-Knowlg:release-8.0.0from
Deeksha1502:update-readme

Conversation

@Deeksha1502
Copy link
Copy Markdown
Contributor

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Type of change

Please choose appropriate options.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes in the below checkboxes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Ran Test A
  • Ran Test B

Test Configuration:

  • Software versions:
  • Hardware versions:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@HarishGangula HarishGangula requested a review from Copilot June 4, 2025 06:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates the README to document the automated release process for publishing the Sunbird PDF Player packages to NPM.

  • Adds a Release Process section describing the GitHub Actions workflow steps.
  • Details prerequisites and separate publishing steps for the web component and main module.
  • Specifies commands, package names, and NPM token requirements.

@HarishGangula HarishGangula merged commit 22d1729 into Sunbird-Knowlg:release-8.0.0 Jun 4, 2025
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants