Skip to content

[DOC] Don't add development dependencies to release notes #104

@tbouffard

Description

@tbouffard

Currently, in the Dependencies update section of the release notes, we display the changes that apply to all types of dependencies. They include bump of development dependencies and GitHub Actions.
Most of the time, we only have updates for this kind of dependencies and we have plenty of them.

Thus, it is difficult to see that a runtime dependency has changed and, in its current form, the Update Dependencies section is not useful to library users.
It is the same issue as process-analytics/bpmn-visualization-js#2208.

Version Current list Useful list for users
pending v0.1.3 bpmn-visualization-R_01_current_all_dependencies bpmn-visualization-R_02_only_prod_dependencies

Proposal

It is the same as process-analytics/bpmn-visualization-js#2208 but here the process is simpler.
Dependabot only updates GitHub Actions: it can set the skip-changelog label and we won't have to do post-processing.
The bpm-visualization JS lib is updated by a PR created by a workflow we own, and other dependencies are updated with PR created by contributors.

Recently, we introduced a shared configuration for release-drafter: see process-analytics/.github#14 and process-analytics/github-actions-playground#132.
It can be used in this repository as the release-notes layout will be exactly the same as the one defined in the shared configuration.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions