From 51cdbad1e6e28d33fb63a5a34c4e724c4bcc9beb Mon Sep 17 00:00:00 2001
From: Max Kless <maxk@nrwl.io>
Date: Thu, 22 Jun 2023 11:37:45 +0300
Subject: [PATCH] fix(misc): mark name as required for ci-workflow generator

---
 .../workspace/generators/ci-workflow.json     |  2 +-
 .../ci-workflow/ci-workflow.spec.ts           | 19 +++++++++++++------
 .../src/generators/ci-workflow/ci-workflow.ts |  4 ++--
 .../src/generators/ci-workflow/schema.json    |  2 +-
 4 files changed, 17 insertions(+), 10 deletions(-)

diff --git a/docs/generated/packages/workspace/generators/ci-workflow.json b/docs/generated/packages/workspace/generators/ci-workflow.json
index 4bc96bfa6a21a..88e6817f72ab7 100644
--- a/docs/generated/packages/workspace/generators/ci-workflow.json
+++ b/docs/generated/packages/workspace/generators/ci-workflow.json
@@ -40,7 +40,7 @@
         "pattern": "^[a-zA-Z].*$"
       }
     },
-    "required": ["ci"],
+    "required": ["ci", "name"],
     "presets": []
   },
   "description": "Generate a CI workflow.",
diff --git a/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts b/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts
index 45e4e5fffe238..76a343abfb685 100644
--- a/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts
+++ b/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts
@@ -28,7 +28,7 @@ describe('CI Workflow generator', () => {
 
       it('should generate github CI config', async () => {
         setNxCloud(tree);
-        await ciWorkflowGenerator(tree, { ci: 'github' });
+        await ciWorkflowGenerator(tree, { ci: 'github', name: 'CI' });
 
         expect(
           tree.read('.github/workflows/ci.yml', 'utf-8')
@@ -37,14 +37,14 @@ describe('CI Workflow generator', () => {
 
       it('should generate circleci CI config', async () => {
         setNxCloud(tree);
-        await ciWorkflowGenerator(tree, { ci: 'circleci' });
+        await ciWorkflowGenerator(tree, { ci: 'circleci', name: 'CI' });
 
         expect(tree.read('.circleci/config.yml', 'utf-8')).toMatchSnapshot();
       });
 
       it('should generate azure CI config', async () => {
         setNxCloud(tree);
-        await ciWorkflowGenerator(tree, { ci: 'azure' });
+        await ciWorkflowGenerator(tree, { ci: 'azure', name: 'CI' });
 
         expect(tree.read('azure-pipelines.yml', 'utf-8')).toMatchSnapshot();
       });
@@ -63,7 +63,10 @@ describe('CI Workflow generator', () => {
 
       it('should generate bitbucket pipelines config', async () => {
         setNxCloud(tree);
-        await ciWorkflowGenerator(tree, { ci: 'bitbucket-pipelines' });
+        await ciWorkflowGenerator(tree, {
+          ci: 'bitbucket-pipelines',
+          name: 'CI',
+        });
 
         expect(tree.read('bitbucket-pipelines.yml', 'utf-8')).toMatchSnapshot();
       });
@@ -75,7 +78,10 @@ describe('CI Workflow generator', () => {
         nxJson.affected.defaultBase = 'my-branch';
         writeJson(tree, 'nx.json', nxJson);
 
-        await ciWorkflowGenerator(tree, { ci: 'bitbucket-pipelines' });
+        await ciWorkflowGenerator(tree, {
+          ci: 'bitbucket-pipelines',
+          name: 'CI',
+        });
 
         expect(readJson(tree, 'nx.json').affected.defaultBase).toEqual(
           'origin/my-branch'
@@ -84,7 +90,7 @@ describe('CI Workflow generator', () => {
 
       it('should generate gitlab config', async () => {
         setNxCloud(tree);
-        await ciWorkflowGenerator(tree, { ci: 'gitlab' });
+        await ciWorkflowGenerator(tree, { ci: 'gitlab', name: 'CI' });
 
         expect(tree.read('.gitlab-ci.yml', 'utf-8')).toMatchSnapshot();
       });
@@ -93,6 +99,7 @@ describe('CI Workflow generator', () => {
         await expect(
           ciWorkflowGenerator(tree, {
             ci: 'github',
+            name: 'CI',
           })
         ).rejects.toThrowErrorMatchingSnapshot();
       });
diff --git a/packages/workspace/src/generators/ci-workflow/ci-workflow.ts b/packages/workspace/src/generators/ci-workflow/ci-workflow.ts
index 6c9ab2b247cf6..64617432a3fdb 100644
--- a/packages/workspace/src/generators/ci-workflow/ci-workflow.ts
+++ b/packages/workspace/src/generators/ci-workflow/ci-workflow.ts
@@ -12,7 +12,7 @@ import {
 import { deduceDefaultBase } from '../../utilities/default-base';
 
 export interface Schema {
-  name?: string;
+  name: string;
   ci: 'github' | 'azure' | 'circleci' | 'bitbucket-pipelines' | 'gitlab';
 }
 
@@ -47,7 +47,7 @@ interface Substitutes {
 
 function normalizeOptions(options: Schema): Substitutes {
   const { name: workflowName, fileName: workflowFileName } = names(
-    options.name || 'CI'
+    options.name
   );
   const { exec: packageManagerPrefix, ciInstall: packageManagerInstall } =
     getPackageManagerCommand();
diff --git a/packages/workspace/src/generators/ci-workflow/schema.json b/packages/workspace/src/generators/ci-workflow/schema.json
index 1778db5c48e8b..f1060142d9f95 100644
--- a/packages/workspace/src/generators/ci-workflow/schema.json
+++ b/packages/workspace/src/generators/ci-workflow/schema.json
@@ -34,5 +34,5 @@
       "pattern": "^[a-zA-Z].*$"
     }
   },
-  "required": ["ci"]
+  "required": ["ci", "name"]
 }