@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

1. In your project directory, run yarn create @rapyuta-robotics/npm-package
2. 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
3. If it's a react project, React Template will be used to generate your project settings
4. If it's a non-react project, Default Template will be used to generate your project settings
5. Once done, your project should be set-up according to the chosen template.
6. Ask [email protected] to enable RR_NPM_TOKEN organization secret in your repository (required to enable CI to publish npm packages)
7. Happy developing!

How to develop this package locally

1. Install dependencies using yarn install
2. Run yarn test-bin to test the create-npm-package.js script locally
3. Modify the create-npm-package.js script accordingly
4. Modify the templates if any update is needed
5. Once done, commit, push and create a pull request
6. 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:

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

References

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