Skip to content

v1.0.0

Choose a tag to compare

View all tags
@univdev univdev released this 02 Apr 02:24
· 5 commits to master since this release
v1.0.0
486647a

WW Timer Project Version 1.0.0 Release Notes

We're excited to announce the release of version 1.0.0 of our project. This major update includes several new features, improvements, and breaking changes aimed at enhancing functionality, code quality, and deployment processes. Below is a summary of the significant changes included in this release.

✨ New Features

  • Created WW Timer: Introduced the WW Timer feature to our project, providing a robust timing solution.
  • Rollup Configuration for ES Module Bundling: Added a rollup.config.js file to configure the bundling process, ensuring efficient bundling for use with modern JavaScript module systems.
  • Workflow for Deploying Package to NPM with Version Confirmation: Introduced a new GitHub Actions workflow to automate the deployment process to NPM, requiring manual version confirmation for intentional and verified deployments.

💥 Breaking Changes

  • Changed 'play' Method Name to 'start': To improve code readability and make the method's purpose more intuitive, we have renamed the play method in the WWTimer class to start. This change affects how the method is called and will require updates in your code where the method is used.

🔄 Updates and Refinements

  • Updated for NPM Deploy: Made necessary updates to prepare for NPM deployment.
  • Defined Keywords: Specified keywords to improve the discoverability of our package on NPM.
  • Build Script Update and Rollup as a Dev Dependency: Simplified the "build" script to use Rollup configuration, and added Rollup as a development dependency to ensure a consistent build process.
  • Enhanced NPM Deployment Workflow: Enhanced the GitHub Actions workflow for NPM deployment by specifying the registry-url and including the NODE_AUTH_TOKEN for secure publishing.

🛠 Other Improvements

  • Added ESLint Rules: Introduced new ESLint rules to maintain high code quality.
  • Added Husky: Implemented Husky to enforce pre-commit hooks for code quality checks.
  • Removed Deploy Script from package.json: Streamlined the project's scripts by removing the "deploy" script, shifting towards utilizing external CI/CD pipelines for deployments.
  • Updated Deployment Command in GitHub Actions: Changed the deployment command to use npm publish directly, ensuring a smoother and more direct publishing process.

📚 Documentation

  • API Changes Reflected: Updated documentation to reflect the API changes, ensuring that the documentation remains accurate and helpful.

🔒 License

  • Added LICENSE File: Included a LICENSE file to clearly state the terms under which our project can be used.

We encourage all users to update to the latest version to take advantage of these improvements and changes. Please note the breaking changes and adjust your implementations accordingly. Thank you for your support, and we look forward to further enhancing our project in future releases.

Assets 2
Loading