https://github.com/process-analytics/bpmn-visualization-addons
Add-ons for `bpmn-visualization`.
https://github.com/process-analytics/bpmn-visualization-addons
addons bpmn extensions hacktoberfest plugins typescript visualization
Last synced: 16 days ago
JSON representation
Add-ons for `bpmn-visualization`.
- Host: GitHub
- URL: https://github.com/process-analytics/bpmn-visualization-addons
- Owner: process-analytics
- License: apache-2.0
- Created: 2023-07-17T05:41:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T05:00:39.000Z (17 days ago)
- Last Synced: 2025-05-07T06:18:54.245Z (17 days ago)
- Topics: addons, bpmn, extensions, hacktoberfest, plugins, typescript, visualization
- Language: TypeScript
- Homepage: https://process-analytics.github.io/bpmn-visualization-addons/
- Size: 2.08 MB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
bpmn-visualization-addons
## 🔆 Presentation
`bpmn-visualization-addons` offers new functionalities to [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) 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](packages/addons/README.md).
A live demo is available at ⏩ https://process-analytics.github.io/bpmn-visualization-addons/.
The sources of the demo are available in the [demo](./packages/demo) folder.
## ⚒️ Development Setup
Use the node version declared in [.nvmrc](.nvmrc). You can use a Node version manager like [nvm](https://github.com/nvm-sh/nvm): `nvm use`
This project uses [npm workspaces](https://docs.npmjs.com/cli/v9/using-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](https://typicode.github.io/husky/how-to.html#startup-files) and add the following content (this example is given for Linux or macOS when using nvm):
```bash
# 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) license.
Copyright © 2023-present, Bonitasoft S.A.
## 🚀 Release how-to
When all updates have been completed, you are ready to publish a new release.
### Release preparation
Decide on the new version depending on the type of changes:
- Follow [semver](https://semver.org/)
- Check the new commits since the latest release to determine the type of changes included in the new version. This can be done by:
- running locally `git log --oneline ..HEAD`
- going the [latest GitHub release page](https://github.com/process-analytics/bpmn-visualization-addons/releases/latest) and checking the commits since this release (a link is available just above the release title).
- Until we release the first major version, bump the minor version if the release contains new features or breaking changes.
A GitHub release is published as part of the release process, and it includes an auto-generated release notes which is based on the labels of the merged Pull Requests:
- Label all merged PRs in the release. Check [unlabeled PRs](https://github.com/process-analytics/bpmn-visualization-addons/pulls?q=is%3Apr+sort%3Aupdated-desc+no%3Alabel+is%3Amerged) to add missing labels.
- Ensure that all PRs related to bump production dependencies (e.g., `bpmn-visualization`) do not have the `skip-changelog` label. Otherwise, they are not included in the changelog.
Find such PRs here: [bump prod dependency PR with skip-changelog label](https://github.com/process-analytics/bpmn-visualization-addons/pulls?q=is%3Apr+is%3Amerged+%22chore%28deps%29%22+in%3Atitle+NOT+%22chore%28deps-dev%29%22+in%3Atitle+label%3Askip-changelog+).
**Note**: Currently, dependabot can't apply different labels to production and development dependency update PRs, so labels must be checked manually.
For more details, see the [dependabot labels documentation](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#labels--).
### Perform the Release
Go to the [release workflow](https://github.com/process-analytics/bpmn-visualization-addons/actions/workflows/release.yml) 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.
- Verify that all issues related to the upcoming release are attached to the milestone. In particular, check the issues that [do not have a milestone](https://github.com/process-analytics/bpmn-visualization-addons/issues?q=is%3Aissue+is%3Aclosed+no%3Amilestone).
- 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](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release):
- The release notes has been [automatically generated](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes). Review and adjust it if necessary.
- Publish the GitHub release
## ⚡ Powered by
**[GitHub Pages](https://pages.github.com/)** (demo live environment)
**[surge.sh](https://surge.sh)** (demo preview environment)