Format Versions

Format Versions#

This page outlines changes introduced in different formatVersion values for the Regolith config.json file.

  • 1.2.0: The first available formatVersion. If the formatVersion field is not specified, this value is used as the default.

  • 1.4.0: This version introduced changes to the export field functionality. You can learn about the current implementation of export targets on its dedicated page.Unfortunately, the 1.4.0 format change was made before Regolith implemented versioned documentation. To review its previous behavior, you’ll need to consult the source of the old documentation .

  • 1.8.0: This version introduced multiple export targets per profile, allowing the export field to accept an array of export target objects in addition to a single object, and added the Bun filters.

Warning

The formatVersion field was introduced later in Regolith’s development.

A new formatVersion is created whenever changes to the configuration file format break backward compatibility. The formatVersion values correspond to the version of Regolith that introduced them.

Not every version of Regolith introduces a new formatVersion. If this field is omitted from the config.json file, the lowest possible value, 1.2.0, is used by default.