Page MenuHomeVyOS Platform

Do not include "dirty" in build commit IDs
Closed, ResolvedPublic

Description

We include the commit ID of vyos-build in the image version, to indicate which exact vyos-build source code was used in the build.

In git, a repository that has uncommitted changes is called "dirty".

That means that when there are uncommitted files in vyos-build, version data will have Build commit ID: ${hash}-dirty.

vyos@r15:~$ show version | match dir
Build commit ID:  d8038ded37fadb-dirty

Having uncommited files in vyos-build is completely normal: custom configs, EULA files in official release builds, anything else that flavor files may include.

However, many people are not familiar with the specific meaning of "dirty" in git or with the build process and assume that "dirty" means something went wrong with the image build.

We should remove the "dirty" part from commit IDs since it doesn't convey any useful information to either developers or users and may confuse end users instead,

Details

Version
-
Is it a breaking change?
Perfectly compatible
Issue type
Cosmetic issue (typos etc.)