Releases: process-analytics/bpmn-visualization-R
0.5.0
This new version allows you to style the BPMN elements of the displayed diagram.
CRAN: this version is available on CRAN.
The bpmnVisualizationR
package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.5.0 to get the list of issues covered by this release.
Highlights
Breaking changes
The way in which overlay styles are created has been simplified.
Previously, several functions had to be called to create the style elements:
taskStyle <- bpmnVisualizationR::create_style(
fill = bpmnVisualizationR::create_fill(color = 'MistyRose'),
font = bpmnVisualizationR::create_font(color = 'DarkSlateGray', size = 23),
stroke = bpmnVisualizationR::create_stroke(color = 'Red')
),
These intermediate functions were removed (create_font
, create_fill
and create_stroke
functions are now internal functions).
create_style
has been renamed in create_overlay_style
(for clarity and consistency with the new functions that let style BPMN elements), and now, you simply have to call this function to create the style of an overlay:
taskStyle <- bpmnVisualizationR::create_overlay_style(
font_color = 'DarkSlateGray',
font_size = 23,
fill_color = 'MistyRose',
stroke_color = 'Red'
)
ℹ️ For more details, see #245
New parameter to style BPMN Elements
The BPMN elements of the diagram can specificly be styled with the new create_shape_style
and create_edge_style
functions as shown below 👇🏿:
bpmnElementStyles <- list(
bpmnVisualizationR::create_shape_style(
elementIds = list("call_activity_1_1"),
stroke_color = 'RoyalBlue',
font_color = 'DarkOrange',
font_family = 'Arial',
font_size = 12,
font_bold = TRUE,
font_italic = TRUE,
font_strike_through = TRUE,
font_underline = TRUE,
opacity = 75,
fill_color = 'Yellow',
fill_opacity = 50
),
bpmnVisualizationR::create_edge_style(
elementIds = list("sequence_flow_1_4"),
stroke_color = 'DeepPink',
stroke_width = 3,
stroke_opacity = 70,
font_color = 'ForestGreen',
font_family = 'Courier New',
font_size = 14,
font_bold = TRUE,
font_italic = TRUE,
font_strike_through = FALSE,
font_underline = FALSE,
font_opacity = 80,
opacity = 80
)
)
bpmnVisualizationR::display(
bpmn_file,
bpmnElementStyles = bpmnElementStyles,
width='auto',
height='auto'
)
What's Changed
Full Changelog: v0.4.0...v0.5.0
🚀 Improvements
- feat: allow to style BPMN Elements (#247) @csouchet
- feat(style)!: refactor how to build the overlay style (#245) @csouchet
📝 Documentation
- docs: describe the security policy (#250) @tbouffard
- docs: enabling markdown support (#246) @csouchet
- docs: improve the release process (#219) @tbouffard
📦 Dependency updates
- chore(deps): bump bpmn-visualization from 0.39.0 to 0.40.0 (#253) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.38.1 to 0.39.0 (#242) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.38.0 to 0.38.1 (#240) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.37.0 to 0.38.0 (#237) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.36.0 to 0.37.0 (#232) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.35.0 to 0.36.0 (#230) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.34.1 to 0.35.0 (#229) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.33.1 to 0.34.1 (#226) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.33.0 to 0.33.1 (#222) @process-analytics-bot
👻 Maintenance
- chore: prepare CRAN submission for 0.5.0 (#254) @tbouffard
- ci(release): eliminate bypassing of branch protection (#249) @tbouffard
- refactor: simplify overlay management in JS bridge code (#248) @tbouffard
- chore(release): publish announce tweet manually (#241) @tbouffard
0.4.0
This new version allows you to choose the style and position of the overlays.
IMPORTANT: this version is only available when installing from GitHub.
The bpmnVisualizationR
package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.4.0 to get the list of issues covered by this release.
Highlights
Previously, the style and the position of the overlays were not configurable.
Now, it is also possible to change the position and the style of the overlays like in the following screenshot:
What's Changed
Full Changelog: v0.3.2...v0.4.0
🚀 Improvements
- feat(overlay): allow to set the overlay position (#210) @csouchet
- feat(overlay): allow to set the overlay style (#207) @csouchet
📝 Documentation
- docs: add more examples for styles and positions of overlays (#218) @tbouffard
- docs: update the documentation after CRAN publication (#205) @csouchet
📦 Dependency updates
- chore(deps): bump bpmn-visualization from 0.32.0 to 0.33.0 (#213) @process-analytics-bot
- chore(deps): bump bpmn-visualization from 0.31.0 to 0.32.0 (#208) @process-analytics-bot
- [INFRA] Bump bpmn-visualization from 0.29.2 to 0.31.0 (#196) @process-analytics-bot
👻 Maintenance
- refactor(test): format and cut tests (#209) @csouchet
- chore: ensure that the PR title follows "Conventional Commits" (#203) @tbouffard
0.3.2
This new version focuses on documentation improvements, mainly to meet CRAN requirements.
It is available at CRAN.
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
What's Changed
Full Changelog: v0.3.1...v0.3.2
📝 Documentation
- fix: update the DESCRIPTION file and the R doc according last submission (#195) @csouchet
- [DOC] Improve the release how-to (#193) @tbouffard
0.3.1
This new version focuses on documentation improvements, mainly to meet CRAN requirements.
The bpmnVisualizationR
package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.3.1 to get the list of issues covered by this release.
What's Changed
Full Changelog: v0.3.0...v0.3.1
📝 Documentation
- [DOC] Prepare CRAN submission for v0.3.1 (#192) @tbouffard
- [DOC] Fix CRAN submission (#184) @csouchet
- [DOC] Fix the maintainer documentation after the package renaming (#183) @csouchet
📦 Dependency updates
- [INFRA] Bump bpmn-visualization from 0.29.1 to 0.29.2 (#191) @process-analytics-bot
- [INFRA] Bump bpmn-visualization from 0.29.0 to 0.29.1 (#181) @process-analytics-bot
👻 Maintenance
0.3.0
This new version brings a BREAKING CHANGE (new package name) and documentation improvements.
The bpmnVisualizationR
package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.3.0 to get the list of issues covered by this release.
Highlights
⚠️ ⚠️ ⚠️ BREAKING CHANGE ⚠️ ⚠️ ⚠️
To avoid confusion with the bpmn-visualization TypeScript library, we decide to change the name of this package.
Old package name | New package name |
---|---|
bpmnVisualization | bpmnVisualizationR |
To migrate to the newest version:
- uninstall
bpmnVisualization
- install
bpmnVisualizationR
- update your R code by changing all functions prefixes from
bpmnVisualization::xxx
tobpmnVisualizationR::xxx
Documentation
The documentation is now available on the GitHub Pages 🎉
What's Changed
Full Changelog: v0.2.2...v0.3.0
📝 Documentation
- [DOC] Warn users for releases not available on CRAN (#178) @tbouffard
- [DOC] Prefix function calls with the package name in examples (#149) @tbouffard
- [DOC] Deploy Documentation to GitHub Pages (#163) @tbouffard
- [DOC] Enrich the HTML documentation (#147) @tbouffard
- [DOC] Improve the release process steps (#152) @tbouffard
📦 Dependency updates
- [INFRA] Bump bpmn-visualization JS lib from 0.28.2 to 0.29.0 (#169) @process-analytics-bot
- [INFRA] Bump bpmn-visualization JS lib from 0.28.1 to 0.28.2 (#162) @process-analytics-bot
👻 Maintenance
- [REFACTOR] Rename the package as bpmnVisualizationR (#172) @csouchet
- [INFRA] Simplify release announces (#174) @csouchet
- [INFRA] Update the index.md file as part of the release process (#164) @tbouffard
- [INFRA] Use the ubuntu-22.04 runner in all GitHub workflows (#168) @tbouffard
0.2.2
This new version makes improvements to the documentation, primarily to correct comments from the last attempt to submit to CRAN.
The R package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.2.2 to get the list of issues covered by this release.
What's Changed
Full Changelog: v0.2.1...v0.2.2
📝 Documentation
- [DOC] Publish HTML documentation preview on surge (#128) @tbouffard
- [DOC] Improve wording and fix typo in the CONTRIBUTING guide (#150) @tbouffard
- [DOC] Update the license header in the JavaScript file (#148) @tbouffard
- [DOC] Simplify the CRAN submission (#144) @tbouffard
- [DOC] Improve the "Release Notes" writing steps (#143) @tbouffard
- [DOC] Fix the documentation to better match CRAN requirements (#142) @csouchet
📦 Dependency updates
- [INFRA] Bump bpmn-visualization JS lib from 0.28.0 to 0.28.1 (#140) @process-analytics-bot
- [INFRA] Bump bpmn-visualization JS lib from 0.26.2 to 0.28.0 (#138) @process-analytics-bot
👻 Maintenance
0.2.1
This new release focuses on maintenance. Thanks to @ColinFay for introducing automatic tests in the package.
The R package now uses [email protected].
Thanks to all the contributors of this release 🌈: @ColinFay, @csouchet and @tbouffard
What's Changed
Full Changelog: v0.2.0...v0.2.1
📝 Documentation
- [DOC] Change the project email (#135) @csouchet
- [DOC] Improve the release process (#132) @tbouffard
- [DOC] Improve the documentation to better match CRAN requirements (#124) @csouchet
📦 Dependency updates
- [INFRA] Bump bpmn-visualization JS lib from 0.26.0 to 0.26.2 (#110) @process-analytics-bot
👻 Maintenance
0.2.0
This new release focuses on maintenance. The R package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet, @oanesini and @tbouffard
See milestone 0.2.0 to get the list of issues covered by this release.
What's Changed
Full Changelog: v0.1.2...v0.2.0
📝 Documentation
- [DOC] Do not add dev dependencies to release notes (#105) @tbouffard
- [DOC] Update how to "update BPMN Visualization version" (#80) @csouchet
- [DOC] Clean SVG hero (#78) @csouchet
📦 Dependency updates
- [INFRA] Bump bpmn-visualization JS lib from 0.25.1 to 0.26.0 (#101) @process-analytics-bot
- [INFRA] Bump BPMN Visualization version from 0.23.2 to 0.25.1 (#95) @process-analytics-bot
- [INFRA] Bump BPMN Visualization version from 0.23.0 to 0.23.2 (#82) @process-analytics-bot
👻 Maintenance
- [INFRA] Update wording in the GH WF bumping bpmn-visualization (#100) @tbouffard
- [INFRA] Fix branch name in workflow updating bpmn-visualization (#81) @tbouffard
- [INFRA] Improve usage of the r-lib action (#79) @tbouffard
- [INFRA] Automate bpmn-visualization-js update (#34) @csouchet
- [INFRA] Fix the milestone link in the release-drafter configuration (#75) @tbouffard
0.1.2
This new release focuses on maintenance. The R package now uses [email protected].
Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard
See milestone 0.1.2 to get the list of issues covered by this release.
What's Changed
🚀 Improvements
- [EXAMPLE] Improve waypoints in the 'email voting' diagram (#71) @tbouffard
📝 Documentation
- [DOC] Update the hero image (#72) @csouchet
- [DOC] Explain how to install a specific version (#70) @tbouffard
- [DOC] Improve shiny application example in README (#60) @tbouffard
- [DOC] Include milestone management in release (#63) @tbouffard
- [DOC] Improve examples rendering in the README (#64) @tbouffard
👻 Maintenance
- [RELEASE] Set version to 0.1.2 (#74) @tbouffard
- [INFRA] Improve the release-notes generation (#66) @tbouffard
- [INFRA] Configure dependabot for gha update (#67) @tbouffard
- [INFRA] Only run
R-CMD-check
workflow on source code changes (#62) @tbouffard
📦 Dependency updates
- [INFRA] gha - Bump actions/checkout from 2 to 3 (#69) @dependabot
- [INFRA] gha - Bump actions/cache from 2 to 3 (#68) @dependabot
- [INFRA] Bump 'bpmn-visualization' from 0.19.4 to 0.23.0 (#65) @csouchet
Full Changelog: v0.1.1...v0.1.2
0.1.1
This new release focuses on documentation improvements and API robustness.
Many thanks to @alachambre who contributed to both topics 💖.
Thanks to all the contributors of this release 🌈: @alachambre, @csouchet and @tbouffard
See milestone 0.1.1 to get the list of issues covered by this release.
What's Changed
🚀 Improvements
- [FEAT] Ensure overlays are passed as a list to the js function (#57) @alachambre
📝 Documentation
- [DOC] Update the development documentation (#56) @csouchet
- [DOC] Add a step to install devtools in the readme (#54) @alachambre
- [DOC] Remove duplicated words in function documentation (#53) @alachambre
- [DOC] Fix the documentation to create an overlay (#52) @csouchet
- [DOC] Fix the link of the Code of conduct (#51) @csouchet
👻 Maintenance
- [INFRA] Don't run build with R-Devel (#55) @tbouffard
- [INFRA] Clean warnings to facilitate CRAN submission (#49) @tbouffard
- [INFRA] Integrate feedback of the first release (#48) @tbouffard
📦 Dependency updates
- [INFRA] Bump bpmn-visualization from 0.19.0 to 0.19.4 (#61) @tbouffard