Skip to content

Developer documentation

Stefan Dirix edited this page Dec 15, 2023 · 27 revisions

Developer documentation

Release process

  • Releases are managed by the "Publish" Github Action
  • Github Bot account jsonforms-publish is allowed to bypass branch protections to push the version update commits on the master branch. For this a time-restricted PAT is used which needs to be renewed regularly.
  • NpmJS Bot account jsonforms-publish is allowed to release new JSON Forms packages on NpmJS. For this a time-restricted access token is used which needs to be renewed regularly.

Creating a new release

Releases are created and published via the "Publish" Github Action

Post-Release Full

  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 jsonforms-angular-seed
  5. Update jsonforms-vue-seed
  6. Update jsonforms2-website
    • Generate and copy API docs
  7. Create changelog by going through all PRs since last stable release
  8. Mark published tag as release in Github and attach changelog
  9. Close milestone
  10. Update news in website

Post-Release Prerelease

  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. Rebuild jsonforms2-website to update next version tag
  4. Do the twitter when it makes sense