chore: add banner to the merged schema file

Author: justandras

packages/live-status-gateway-api/package.json

@@ -15,7 +15,7 @@
 	},
 	"homepage": "https://github.com/nrkno/sofie-core/blob/master/packages/live-status-gateway-api#readme",
 	"scripts": {
-		"build": "yarn resolve-nested-examples && yarn generate-schema-types && run -T rimraf dist && run build:main",
+		"build": "yarn generate-schema-types && run -T rimraf dist && run build:main",
 		"build:main": "run -T tsc -p tsconfig.build.json",
 		"lint:raw": "run -T eslint",
 		"lint": "run lint:raw .",
@@ -27,11 +27,11 @@
 		"validate:dependencies": "yarn npm audit --environment production && run license-validate",
 		"validate:dev-dependencies": "yarn npm audit --environment development",
 		"license-validate": "run -T sofie-licensecheck",
-		"gendocs": "yarn resolve-nested-examples && ag ./dist/api/asyncapi.yaml @asyncapi/html-template -o docs -p singleFile=true -p outFilename=liveStatus.html",
-		"genserver": "yarn resolve-nested-examples && ag ./dist/api/asyncapi.yaml @asyncapi/nodejs-ws-template -o server -p server=development",
-		"generate-schema-types": "yarn resolve-nested-examples && node scripts/generate-schema-types.mjs",
-		"resolve-nested-examples": "node scripts/resolve-nested-examples.mjs && yarn merge-schemas",
-		"merge-schemas": "node scripts/merge-schemas.mjs"
+		"gendocs": "yarn merge-schemas && ag ./src/generated/asyncapi.yaml @asyncapi/html-template -o docs -p singleFile=true -p outFilename=liveStatus.html",
+		"genserver": "yarn merge-schemas && ag ./src/generated/asyncapi.yaml @asyncapi/nodejs-ws-template -o server -p server=development",
+		"generate-schema-types": "yarn merge-schemas && node scripts/generate-schema-types.mjs",
+		"resolve-nested-examples": "node scripts/resolve-nested-examples.mjs",
+		"merge-schemas": "yarn resolve-nested-examples && node scripts/merge-schemas.mjs"
 	},
 	"engines": {
 		"node": ">=14.19"

packages/live-status-gateway-api/scripts/merge-schemas.mjs

@@ -6,6 +6,11 @@ import { fromFile, Parser } from '@asyncapi/parser'
 const ROOT_FILE = './temp/api/asyncapi.yaml'
 const OUTPUT_FILE = './src/generated/asyncapi.yaml'
 
+const BANNER =
+	'# This file was automatically generated using @asyncapi/parser\n' +
+	'# DO NOT MODIFY IT BY HAND. Instead, modify the source AsyncAPI schema files,\n' +
+	'# and run "yarn merge-schemas" to regenerate this file.\n'
+
 async function main() {
 	try {
 		const parser = new Parser()
@@ -15,14 +20,12 @@ async function main() {
 			throw new Error('Failed to parse the AsyncAPI document.')
 		}
 
-		// Convert the resolved document to JS object
 		const resolved = document.json()
-
-		// Ensure output directory exists
 		fs.mkdirSync(path.dirname(OUTPUT_FILE), { recursive: true })
 
-		// Write out single YAML file
-		fs.writeFileSync(OUTPUT_FILE, YAML.stringify(resolved), 'utf-8')
+		// Prepend banner to YAML output
+		const yamlContent = BANNER + YAML.stringify(resolved)
+		fs.writeFileSync(OUTPUT_FILE, yamlContent, 'utf-8')
 
 		console.log(`Fully resolved AsyncAPI schema written to: ${OUTPUT_FILE}`)
 	} catch (err) {

packages/live-status-gateway-api/src/generated/asyncapi.yaml

@@ -1,3 +1,6 @@
+# This file was automatically generated using @asyncapi/parser
+# DO NOT MODIFY IT BY HAND. Instead, modify the source AsyncAPI schema files,
+# and run "yarn resolve-nested-examples" to regenerate this file.
 asyncapi: 2.6.0
 id: sofie:live-status-gateway:server
 info: