Skip to content

Latest commit

 

History

History
117 lines (81 loc) · 5.42 KB

README.md

File metadata and controls

117 lines (81 loc) · 5.42 KB
Raw

bpmn-visualization-addons


🔆 Presentation

bpmn-visualization-addons offers new functionalities to bpmn-visualization in the form of addons.

bpmn-visualization-addons is being actively developed. Before the release of version 1.0.0, there may be some breaking changes.

🎨 Features and Usage

See the dedicated README.

A live demo is available at ⏩ https://process-analytics.github.io/bpmn-visualization-addons/. The sources of the demo are available in the demo folder.

⚒️ Development Setup

Use the node version declared in .nvmrc. You can use a Node version manager like nvm: nvm use

This project uses npm workspaces.

Install dependencies: npm install

Develop the lib and live update the demo: run npm run dev:demo. The demo is accessible at http://localhost:5173/

Husky settings when using Node Version Managers

Husky runs the pre-commit hook before each commit to ensure that the code meets the standards.

On commit, if you use a Node Manager, the pre-commit hook may generate an Command not found error. If so, create a startup file and add the following content (this example is given for Linux or macOS when using nvm):

# This loads nvm.sh and sets the correct PATH before running hook
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

For more details, see

📃 License

bpmn-visualization-addons is released under the Apache 2.0 license.
Copyright © 2023-present, Bonitasoft S.A.

🚀 Release how-to

When all updates have been completed, you are ready to publish a new release.

Go to the release workflow in GitHub Actions and run it by choosing the type of release.

This workflow:

  • Creates a Git tag
  • Triggers the publishing of the npm package
  • Creates a draft GitHub release

Manage Milestone:

  • Note: we always put issues related to a version in a Milestone whose name matches the version.
  • Ensure the name of the milestone used for the new release version matches the name of the tag/version that has just been pushed. Renamed it if needed.
  • Clean this opened milestone if some issues are still opened (move them to a new one or discard milestone from them)
  • Close the milestone

The release workflow has initiated a new draft GitHub release, which needs to be updated and published :

  • For more details about GitHub release, follow the GitHub help:
  • The release notes has been automatically generated. Review and adjust it if necessary.
  • Publish the GitHub release

⚡ Powered by

GitHub logo

GitHub Pages (demo live environment)

surge.sh logo

surge.sh (demo preview environment)