@rapyuta-robotics/create-npm-package

@rapyuta-robotics/create-npm-package

A package used to provide templates for creating npm packages

How to create a new npm project using create-npm-package

• In your project directory, run yarn create @rapyuta-robotics/npm-package
• Follow the prompts in the CI to provide the project's name, description (optional), github url (optional), and whether it's a react / non-react project
• If it's a react project, React Template will be used to generate your project settings
• If it's a non-react project, Default Template will be used to generate your project settings
• Once done, your project should be set-up according to the chosen template.
• Ask [e-mail] to enable RR_NPM_TOKEN organization secret in your repository (required to enable CI to publish npm packages)
• Happy developing!

How to develop this package locally

• Install dependencies using yarn install
• Run yarn test-bin to test the create-npm-package.js script locally
• Modify the create-npm-package.js script accordingly
• Modify the templates if any update is needed
• Once done, commit, push and create a pull request
• Create a new release to publish the new version

How to publish a new version

A new version will be published to NPM everytime a new release is created

The workflow shall be:

• Create a new release targeting devel. No release branch should be created as we are using trunk-based development approach.
• Tag of the new release should follow semantic versioning with [breaking change (compatibility issue)].[feature update].[bugfix patches] -> (x.y.z)
• Once release is created, github action will automatically publish it to npmjs.

References

• Trunk-based development: https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development