Categories:
Repositories configuration file: aura-config.json
The purpose of the aura-config.json file is to provide a description of the repository to make it easier for releases and CI flows to manage each repository
Description
The aura-config.json configuration file can be created at the root of each Aura project to specify configuration that can be used to automate tasks.
Structure
Sections
{
"release": {
// Release information
},
"docs": {
// Information associated with documentation (for example aura-docs)
}
}
Fields
| Field | Type | Description |
|---|---|---|
| name | string | Library or package name |
| description | string | Library or package description |
| multiRepository | boolean | In deployment tasks, it is used to know if the project contains other projects (packages) |
| release.name | string | Current release name . It can be used by projects like aura-release-manager to increase versions automatically |
| release.version | string | Current release version. It follows the https://semver standard and it can be used by aura-release-manager and jenkins to increase versions automatically |
Fields in bold are required
Visual example
{
"name": "aura-bot-libraries",
"description": "aura-bot-libraries contains all global libraries required in aura-bot.",
"multiRepository": true,
"release": {
"name": "tasos",
"version": "4.0.0"
}
}
Interfaces
AuraConfig
/**
* @interface AuraConfig
* @description Interface to aura-config.json file
*/
export interface AuraConfig {
/**
* Library or package name
*/
name: string;
/**
* Library or package description
*/
description: string;
/**
* In deployment tasks, it is used to know if the project contains other projects (packages)
*/
multiRepository?: boolean;
/**
* Release information
*/
release?: AuraConfigRelease;
}
AuraConfigRelease
/**
* @interface AuraConfigRelease
*/
export interface AuraConfigRelease {
/**
* Contains the current release name . It can be used by projects like aura-release-manager
* to increase versions automatically
*/
name: string;
/**
* Contains the current release version. It follows the https://semver standard and it can be used by
* aura-release-manager and jenkins to increase versions automatically
*/
version: string;
}
Project using aura-config.json
| Project name | Used configuration | Used in |
|---|---|---|
| aura-bot-libraries | release | jenkins |
JSON Schema
Last modified January 15, 2025: feat: Documentation Assistant and ATRIA for Linkin Park release #AURA-26619 [RTM] (409958c0)