dips-releasenotes-extension
This extension will display how DIPS' release notes are rendered and displayed for the customers to ease the process of writing release notes.
Features
This extension will display how DIPS' release notes are rendered and displayed for the customers to ease the process of writing release notes.
Release notes begins with a list of versions with a version number. Each version can contains a list of changes
and/or a list of requiredActions
.
Changes describes the changes made since last release that is noteworthy for the user to know about. They contain a type (change, fix, or news), a title, a description, and a voluntary list of d:saker that the change has adressed.
RequiredAcrions
describes actions or checks that the customer should perform before upgrading to this version. Such as verifying that a new dependency is installed, configuring a new elementtype
++.
Release Note example
productName: my-awesome-product
versions:
- version: 2.1.0
- version: 2.0.0
releaseNotes:
requiredActions:
- Run dup 1.23
- Ensure ehrstore is installed
databaseChanges:
- Lagt på grants
- Lagt til en index på en tabell
changes:
- title: Rekkefølge på evalueringer i behandlingsplannotatet
description: |-
# Tittel
Tekst
## Undertittel
type: change
consequenceForCustomer: Krever brukeropplæring
dsak:
- id: 1234
customer: helse nord
- id: 1235
customer: helse vest
- title: Rekkefølge på evalueringer i behandlingsplannotatet
description: Reekkefoølgen er nå korrekt
type: fix
dsak:
- id: 12351234
customer: diakonhjemmet
- title: Noe nytt kult er lagt til
description: |-
Det er helt sjukt nytt og kult faktisk.
Du kommer ikke til å tro det før du ser det!
type: news
Release Notes
0.3.2
Fix a bug where if requiredActions
or consequenceForCustomer
was not set, it rendered undefined.
0.3.1
Support empty versions.
Support both
productName: my-awesome-product
versions:
- version: 2.1.0
- version: 2.0.0
releaseNotes:
requiredActions:
- Run dup 1.23
- Ensure ehrstore is installed
and
productName: my-awesome-product
versions:
- version: 2.1.0
releaseNotes: {}
- version: 2.0.0
releaseNotes:
requiredActions:
- Run dup 1.23
- Ensure ehrstore is installed
0.4.0
Changed "Løste d:saker" to "Relaterte d:saker"
Convert markdown in description if it is written in markdown.
0.3.0
Update with "konsekvenser for kunde" and database changes. Handle versions without release notes yet.
0.2.0
Update the extension to use the new yaml structure. Examples in the redame is also updated.
0.1.2
Bugfix with rendering multiple changes of the same type.
0.1.1
Added example release notes yaml.
0.1.0
Fixed the indentation of the "d:saker" list.
0.0.1
Initial release of dips-releasenotes-extension
Enjoy!