Enhancing Library Structure through Strategic Package Publishing

[Aby-JS]

Why

To streamline the development and release workflow of our multi-package library, including types, web-core, shared-ui, react-sdk, and react, we need to establish a more structured package publishing approach. This initiative will help to standardize the versioning process, manage dependencies more effectively, and ensure that each package is optimally tailored for end-user consumption, thereby enhancing the overall quality and usability of our library.

TODO

• [ ] Implement Lerna for efficient management and automated publishing of multi-package libraries.
• [ ] Refine package.json in each package to align with the new versioning and publishing strategy.
• [ ] Conduct an in-depth review of dependencies and peer dependencies for each package to streamline integration in various development environments.
• [ ] Test the integration and functionality of all packages in sample applications.

Acceptance Criteria

• [ ] Each package must follow a clear and consistent versioning strategy.
• [ ] Dependencies across packages should be well-managed with minimal conflicts, ensuring seamless integration.
• [ ] The content of each package should be optimized, containing only necessary files, to enhance performance and usability.
• [ ] Successful integration and performance of packages should be demonstrated in sample applications.
• [ ] Packages can be published to npmjs.com via a single command (we can publish alpha versions for now

Implementation Idea

• We will leverage Lerna for its powerful features in managing multi-package repositories, which will facilitate automated version management and publishing.
• The package.json files will be updated to ensure they contain correct versioning information, peer dependencies, and the files array to include only relevant files.
• A rigorous process of dependency review and management will be undertaken to ensure that each package is lean and efficient, providing a seamless experience for developers integrating these packages into their projects.
• Testing will be conducted on sample applications to validate the functionality and integration of the packages post-publishing.

[Aby-JS]

Future plans:

• Adding commit lint to follow conventional commits pattern.
• Adding automated changelog generation.
• Adding automated versioning and publishing of packages.

[incorbador]

@Aby-JS Can you please update the issue to include the sections (why, todo, acceptance criteria, implementation idea) from our issue template (Stefan has proposed it a few weeks ago, we also use it in our "corbado" repository)?

I would put the points from the current acceptance criteria section in the the todo section. To me, acceptance criteria for this ticket could look like this:

• [ ] packages can be published to npmjs.com via a single command (we can publish alpha versions for now)
• [ ] examples still work when using the publishes packages

[Aby-JS]

@incorbador the ticket has been refactored to follow the pattern.

[incorbador]

I think we should also demonstrate here how we would publish to npmjs (from my point of view this is the most important point of this ticket because it proves that have done all the most must-haves to be able to publish to npm). Therefore I think, this should be part of the AC (acceptance criteria), so I would add "packages can be published to npmjs.com via a single command (we can publish alpha versions for now)".

[Aby-JS]

"packages can be published to npmjs.com via a single command (we can publish alpha versions for now

done