Awesome
<h1 align="center">bpmn-visualization-addons</h1> <div align="center"> <p align="center"> <a href="https://npmjs.org/package/@process-analytics/bpmn-visualization-addons"> <img alt="npm package" src="https://img.shields.io/npm/v/@process-analytics/bpmn-visualization-addons.svg?color=orange"> </a> <a href="https://github.com/process-analytics/bpmn-visualization-addons/releases"> <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/process-analytics/bpmn-visualization-addons?label=changelog&include_prereleases"> </a> <a href="https://process-analytics.github.io/bpmn-visualization-addons/"> <img alt="Live Demo" src="https://img.shields.io/badge/demo-online-blueviolet.svg"> </a> <a href="https://github.com/process-analytics/bpmn-visualization-addons/actions"> <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-addons/workflows/Build/badge.svg"> </a> <a href="https://sonarcloud.io/project/overview?id=process-analytics_bpmn-visualization-addons"> <img alt="Code Smells" src="https://sonarcloud.io/api/project_badges/measure?project=process-analytics_bpmn-visualization-addons&metric=code_smells"> </a> <br> <a href=https://github.com/process-analytics/.github/blob/main/CODE_OF_CONDUCT.md"> <img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg"> </a> <a href="LICENSE"> <img alt="License" src="https://img.shields.io/github/license/process-analytics/bpmn-visualization-addons?color=blue"> </a> </p> </div> <br>🔆 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
- https://typicode.github.io/husky/how-to.html#node-version-managers-and-guis
- https://github.com/typicode/husky/issues/912
📃 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
<img src="packages/demo/public/assets/github-logo.svg" alt="GitHub logo" title="GitHub Pages" width="110"/>GitHub Pages (<kbd>demo</kbd> live environment)
<img src="https://surge.sh/images/logos/svg/surge-logo.svg" alt="surge.sh logo" title="surge.sh" width="110"/>surge.sh (<kbd>demo</kbd> preview environment)