feat: [RUN-131] add workflow ID support (#40)

schema.json

@@ -73,6 +73,11 @@
       "items": {
         "type": "object",
         "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-]*$",
+            "description": "Workflow id"
+          },
           "name": {
             "type": "string",
             "description": "Workflow name"

src/commands/workflow/exec.ts

@@ -53,9 +53,13 @@ export const exec = new Command<GlobalOptions>()
 	.arguments('<workflow>')
 	.action(async (options, workflow) => {
 		const { dryRun, mode } = options
-		const cfg = config.get(options as CliOptions) as any
+		const cfg = config.get(options as CliOptions)
 
-		const run = cfg.workflows.find((w: any) => w.name === workflow)
+		if (!cfg.workflows) {
+			throw new ValidationError('No workflows defined in config')
+		}
+
+		const run = cfg.workflows.find((w) => w.id === workflow || w.name === workflow)
 		if (!run) {
 			throw new ValidationError(`Workflow ${workflow} not found`)
 		}

src/lib/schema.ts

@@ -46,6 +46,7 @@ export const ConfigSchema = z.object({
 	}),
 	workflows: z.array(
 		z.object({
+			id: z.string().regex(new RegExp('^[a-zA-Z0-9][a-zA-Z0-9\\-]*$')).optional().describe('Workflow id'),
 			name: z.string().describe('Workflow name'),
 			steps: z.array(
 				z.object({

tests/fixtures/test.config.json

@@ -11,6 +11,7 @@
 	},
 	"workflows": [
 		{
+			"id": "compile-client",
 			"name": "compile client",
 			"steps": [
 				{
@@ -27,6 +28,7 @@
 			]
 		},
 		{
+			"id": "compile-server",
 			"name": "compile server",
 			"steps": [
 				{
@@ -43,6 +45,7 @@
 			]
 		},
 		{
+			"id": "cook-all",
 			"name": "cook all",
 			"steps": [
 				{
@@ -59,6 +62,7 @@
 			]
 		},
 		{
+			"id": "package-client",
 			"name": "package client",
 			"steps": [
 				{
@@ -79,6 +83,7 @@
 			]
 		},
 		{
+			"id": "package-server",
 			"name": "package server",
 			"steps": [
 				{

tests/template.test.ts

@@ -88,6 +88,7 @@ Deno.test('renderConfig should deeply replace all placeholders in config object'
 		metadata: { ts: '2024-02-29T12:34:56Z' },
 		workflows: [
 			{
+				id: 'compile',
 				name: 'compile',
 				steps: [
 					{
@@ -109,6 +110,7 @@ Deno.test('renderConfig should deeply replace all placeholders in config object'
 		metadata: { ts: '2024-02-29T12:34:56Z' },
 		workflows: [
 			{
+				id: 'compile',
 				name: 'compile',
 				steps: [
 					{
@@ -135,6 +137,7 @@ Deno.test('replace paths in template', () => {
 		metadata: { ts: '2024-02-29T12:34:56Z' },
 		workflows: [
 			{
+				id: 'compile',
 				name: 'compile',
 				steps: [
 					{