fix(core): fix workflow naming

nrwl · Apr 19, 2022 · f14e8c3 · f14e8c3
1 parent 0bf70b4
commit f14e8c3
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 6 deletions.
diff --git a/packages/workspace/src/generators/ci-workflow/__snapshots__/ci-workflow.spec.ts.snap b/packages/workspace/src/generators/ci-workflow/__snapshots__/ci-workflow.spec.ts.snap
@@ -109,10 +109,10 @@ jobs:
           command: yarn nx-cloud start-ci-run
       - run:
           name: Run workspace lint
-          command:  nx workspace-lint
+          command: yarn nx workspace-lint
       - run:
           name: Check format
-          command:  nx format:check
+          command: yarn nx format:check
       - run:
           name: Run lint
           command: yarn nx affected --base=$NX_BASE --head=$NX_HEAD --target=lint --parallel=3
@@ -167,3 +167,33 @@ jobs:
       number-of-agents: 3
 "
 `;
+
+exports[`lib should generate github CI config with custom name 1`] = `
+"name: My custom-workflow
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  main:
+    name: Nx Cloud - Main Job
+    uses: nrwl/ci/.github/workflows/nx-cloud-main.yml@v0.2
+    with:
+      parallel-commands: |
+        yarn nx workspace-lint
+        yarn nx format:check
+      parallel-commands-on-agents: |
+        yarn nx affected --target=lint --parallel=3
+        yarn nx affected --target=test --parallel=3 --ci --code-coverage
+        yarn nx affected --target=build --parallel=3
+
+  agents:
+    name: Nx Cloud - Agents
+    uses: nrwl/ci/.github/workflows/nx-cloud-agents.yml@v0.2
+    with:
+      number-of-agents: 3
+"
+`;
diff --git a/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts b/packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts
@@ -26,4 +26,15 @@ describe('lib', () => {
 
     expect(tree.read('azure-pipelines.yml', 'utf-8')).toMatchSnapshot();
   });
+
+  it('should generate github CI config with custom name', async () => {
+    await ciWorkflowGenerator(tree, {
+      ci: 'github',
+      name: 'My custom-workflow',
+    });
+
+    expect(
+      tree.read('.github/workflows/my-custom-workflow.yml', 'utf-8')
+    ).toMatchSnapshot();
+  });
 });
diff --git a/packages/workspace/src/generators/ci-workflow/ci-workflow.ts b/packages/workspace/src/generators/ci-workflow/ci-workflow.ts
@@ -22,17 +22,21 @@ export async function ciWorkflowGenerator(host: Tree, schema: Schema) {
 interface Substitutes {
   mainBranch: string;
   workflowName: string;
+  workflowFileName: string;
   packageManagerInstall: string;
   packageManagerPrefix: string;
   tmpl: '';
 }
 
 function normalizeOptions(options: Schema): Substitutes {
-  const { name: workflowName } = names(options.name || 'build');
+  const { name: workflowName, fileName: workflowFileName } = names(
+    options.name || 'build'
+  );
   const { exec: packageManagerPrefix, ciInstall: packageManagerInstall } =
     getPackageManagerCommand();
   return {
     workflowName,
+    workflowFileName,
     packageManagerInstall,
     packageManagerPrefix,
     mainBranch: deduceDefaultBase(),

diff --git a/packages/workspace/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__ b/packages/workspace/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__
@@ -44,10 +44,10 @@ jobs:
           command: <%= packageManagerPrefix %> nx-cloud start-ci-run
       - run:
           name: Run workspace lint
-          command: <% packageManagerPrefix %> nx workspace-lint
+          command: <%= packageManagerPrefix %> nx workspace-lint
       - run:
           name: Check format
-          command: <% packageManagerPrefix %> nx format:check
+          command: <%= packageManagerPrefix %> nx format:check
       - run:
           name: Run lint
           command: <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD --target=lint --parallel=3
@@ -64,7 +64,7 @@ jobs:
 workflows:
   version: 2
 
-  <%= workflowName %>:
+  <%= workflowFileName %>:
     jobs:
       - agent:
           matrix:

diff --git a/...ub/workflows/__workflowName__.yml__tmpl__ → ...orkflows/__workflowFileName__.yml__tmpl__ b/...ub/workflows/__workflowName__.yml__tmpl__ → ...orkflows/__workflowFileName__.yml__tmpl__