Developer documentation

Developer documenation

Handling of package-lock.json and versioning in JSONForms

• Use the guidlines outlined in First time setup to setup JSONForms.

• By default, the package-lock.json should not be modified

• If you need to update a specific version of a package, do so in an explicit commit and add the package.json and package-lock.json files. Pay attention to package hoisting warnings

  NOTE: There should be no package-lock.json files in any of the packages subfolders. If that is the case, it means that lerna was not able to bootstrap the packages cleanly, likely because of existing hoisting warnings.

• From time to time, we might have commits that only update packages, e.g. when using npm audit

Creating a new release

Release

1. Run npm audit. If any fixes are available, apply them first via a PR
2. npm login with 'eclipsesource'
3. npm run preparePublish
4. Test publishing by either:
   • Publishing to a private npm registry (TODO)
   • by using a custom version number, e.g. using a -rc suffix
5. Publish via lerna publish

Post-Release

1. Check https://www.npmjs.com/search?q=%40jsonforms for the new release
2. Check https://github.com/eclipsesource/jsonforms/releases for the new release
3. Update jsonforms-react-seed
4. Update make-it-happen-react and make-it-happen-angular, if necessary
5. Update jsonforms2-website
   • Generate and copy API docs
6. Create change log by going through all issues in the milestone
7. Publish release on github
8. Close milestone
9. Do the twitter 🐤