Skip to content

Release Number Management

Carina edited this page Dec 16, 2016 · 4 revisions

The knowledgefinder-core, knowledgefinder-dataimport and the knowledgefinder-webapp are always released together. Therefor they always have the same release number. The example project has its own release number.

How to build the release number

<ConfigurationBreakingChanges>.<NewFeatures>.<Bugfixes>

How to increment the release number

Bugfixes

For Bugfixes and correction of typos: Increase <Bugfixes>

⚙️
A bugfix would result in a switch from 1.1.4 to 1.1.5.

New Features

New Features are added to KnowledgeFinder, but previous configuration projects still work: Increase <NewFeatures>, reset <Bugfixes> to 0

⚙️
A new filter type would result in a switch from 1.1.4 to 1.2.0.

Configuration Breaking Changes

Changes in KnowledgeFinder, which break the configuration projects. (The configuration projects NEED to be adapted): Increase <ConfigurationBreakingChanges>, reset <NewFeatures> to 0, reset <Bugfixes> to 0

⚙️
A change in the way the Frontend is configured would result in a switch from 1.1.4 to 2.0.0.

How to build the release number for an instance

The configuration used to create an expert system with KnowledgeFinder is is called an instance.

Instances have their own release numbers. They are build and incremented nearly exactly the same way as the KnowledgeFinder release number. The only differences is that the first number is increased when the configuration is updated to match a new major KnowledgeFinder version.

Example:

  • Start - KnowledgeFinder is in version 1.2.5, the example instance in version 1.6.1.

  • Change - KnowledgeFinder gets updated to version 2.0.0.

  • Status - The example instance now not running with the new KnowledgeFinder version 2.0.0. Its release number does not get updated.

  • Change - The example instance gets updated to match the new KnowledgeFinder configuration format. The release number of the example instance gets increased to 2.0.0.

In general an instance can only be run with the current KnowledgeFinder version with the same first number. Older versions with the same first number may be working, but this cannot be guaranteed, since new features may bring additonal configuration possibilities, without breaking the general configuration format.