modern-yaml.md

File format

Example file

Akeeba Release Maker 2.x configuration files can alternatively be written in the YAML file format. Due to the syntactic simplicity of the format it may be easier to output in build scripts than JSON or JSON5.

The YAML file has 6 top level keys:

• The release section. Contains general information about your software release in Akeeba Release System.
• The api section Describes how Release Maker will connect to Akeeba Release System on your site.
• The steps section Optional. It tells Release Maker which steps to run and in which order when making a release. You don't need to override this unless you are debugging Release Maker.
• The connections section It contains one or more objects which describe how Release Maker will connect to a remote file storage server, such as an (S)FTP server or Amazon S3, to upload your software package and / or update files.
• The updates section Optional. It tells Release Maker which ARS update streams you want to retrieve and upload to a remote server. This allows you to mirror your up-to-date software update streams to static file hosting on your site or a CDN.
• The files section It tells Release Maker where and which files to upload to which server and make them available for download through Akeeba Release Maker.

Also see the Akeeba Release Maker Overview documentation page.