Page History

...

if a change is a bugfix on a previously merged patch, AND if that previous version is not already released:
- then changing the version change is optional
The repos need to have the version number expressed in multiple places
- In pom.xml, the project/version value is always specified as either W.X.Y or W.X.Y-SNAPSHOT, as in 1.3.2-SNAPSHOT.
- Every directory that has a pom.xml file should ALSO have a version.properties file AND a ChangeLog.md file.
  - The exception is when there are subdirectories with individual pom.xml files. In that case, those directories should have a ChangeLog.md file.
- The same value (without any "-SNAPSHOT" suffix) will be specified in version.properties, separated out into separate major, minor and patch values:
  - major=W
  - minor=X
  - patch=Y
- The same value will be specified in the ChangeLog.md file.
- These values MUST match.

Check the Build Console Output

...

In the Istanbul release, we have adopted the practices of keeping a changelog. Best practices for changelogs can be found at <keepachangelog.com>.

An example of a changelog Changelog is:

#

Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https

Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com

/en/1.0.0

,

and

this

project

adheres

to

[Semantic

Versioning](

https

spec/v2.0.0.html). ## [Unreleased] ##

).

## [1.0.

0] - 2017-06-20 ### Added - New visual identity by [@tylerfortune8

6] - 2021/08/28
- [DCAEGEN2-2885](https://jira.onap.org/browse/DCAEGEN2-2885) - DCAE SliceAnalysis MS - CPS Integration

- [DCAEGEN2-2811](https://

github.com/tylerfortune8). - Version navigation. - Links to latest released version in previous versions. - "Why keep a changelog?" section

jira.onap.org/browse/DCAEGEN2-2811) - Remove security vulnerabilities

. . .

As committers, some of the things you should always check are:

The name of the changelog may be specified in any case, but at least the letter "C" must be capitalized. We are using markdown, so the extension should must always be ".md".
Within the changelog:
- The date stamp must always be specified as either YYYY-MM-DD or YYYY/MM/DD.
- The JIRA ticket associated with the changes that went into a version should be noted.
- There should be an entry for every single version.
- The latest version should must always be first, in reverse time order.
- The An [Unreleased] section is optional. The date stamp must always be specified as either YYYY-MM-DD or YYYY/MM/DD.(JIRA tickets should be used in lieu of an [Unreleased] section.)

...