Skip to content

Publish package to npm Registry#70

Merged
Josephat-S merged 1 commit into
devfrom
config/npm
May 26, 2026
Merged

Publish package to npm Registry#70
Josephat-S merged 1 commit into
devfrom
config/npm

Conversation

@Josephat-S
Copy link
Copy Markdown
Contributor

This pull request prepares the project for public release on npm by adding publishing automation, improving package metadata, and specifying files to include or exclude from the npm package. The changes ensure that only the necessary files are published, the package has a clear license, and the publishing process is automated and secure.

Release automation:

  • Added a GitHub Actions workflow (.github/workflows/publish.yml) to automatically publish the package to npm when a new version tag is pushed. This workflow installs dependencies, runs linting, and securely publishes using a token.

Package contents and configuration:

  • Created a .npmignore file to exclude development files, test outputs, configuration files, and unnecessary directories from the published npm package, ensuring a clean and minimal distribution.
  • Updated the files field in package.json to explicitly include only the main executable, source files, README, and license in the published package.

Metadata and licensing:

  • Added an MIT license (LICENSE) to clearly state the project's terms of use and distribution.
  • Improved package.json metadata by adding a meaningful description, relevant keywords, author information, license type, and specifying the minimum required Node.js version.

Closes #49

@Josephat-S Josephat-S requested a review from a team May 26, 2026 10:55
@Josephat-S Josephat-S merged commit 054139b into dev May 26, 2026
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.

Publish to npm Registry

1 participant