docs(core): add missing docs infomation

nrwl · Apr 20, 2022 · 0fdbbb3 · 0fdbbb3
1 parent 126662d
commit 0fdbbb3
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 15 deletions.
diff --git a/docs/generated/packages/workspace.json b/docs/generated/packages/workspace.json
@@ -669,8 +669,7 @@
           "ci": {
             "type": "string",
             "description": "CI provider.",
-            "$default": { "$source": "argv", "index": 0 },
-            "default": "github",
+            "enum": ["github", "circleci", "azure"],
             "x-prompt": {
               "message": "What is your target CI provider?",
               "type": "list",

diff --git a/docs/map.json b/docs/map.json
@@ -498,6 +498,11 @@
             "id": "workspace-generator",
             "path": "/packages/workspace/generators/workspace-generator"
           },
+          {
+            "name": "ci-workflow generator",
+            "id": "ci-workflow-generator",
+            "path": "/packages/workspace/generators/ci-workflow"
+          },
           {
             "name": "convert-to-nx-project generator",
             "id": "convert-to-nx-project-generator",

diff --git a/docs/shared/monorepo-ci-azure.md b/docs/shared/monorepo-ci-azure.md
@@ -40,6 +40,8 @@ variables:
       value: $(git merge-base $(TARGET_BRANCH) HEAD)
     ${{ if ne(variables['Build.Reason'], 'PullRequest') }}:
       value: $(git rev-parse HEAD~1)
+  - name: HEAD_SHA
+    value: $(git rev-parse HEAD)
 
 jobs:
   - job: main
@@ -88,12 +90,13 @@ variables:
       value: $(git merge-base $(TARGET_BRANCH) HEAD)
     ${{ if ne(variables['Build.Reason'], 'PullRequest') }}:
       value: $(git rev-parse HEAD~1)
+  - name: HEAD_SHA
+    value: $(git rev-parse HEAD)
 
 jobs:
   - job: agents
     strategy:
-      matrix:
-        agent: [1, 2, 3]
+      parallel: 3
     displayName: 'Agent $(imageName)'
     pool:
       vmImage: 'ubuntu-latest'
@@ -109,13 +112,15 @@ jobs:
       - script: npx nx-cloud start-ci-run
 
       - script: npx nx workspace-lint
-      - script: npx nx format:check
-      - script: npx nx affected --base=$(BASE_SHA) --target=lint --parallel=3
-      - script: npx nx affected --base=$(BASE_SHA) --target=test --parallel=3 --ci --code-coverage
-      - script: npx nx affected --base=$(BASE_SHA) --target=build --parallel=3
+      - script: npx nx format:check --base=$(BASE_SHA) --head=$(HEAD_SHA)
+      - script: npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) --target=lint --parallel=3
+      - script: npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) --target=test --parallel=3 --ci --code-coverage
+      - script: npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) --target=build --parallel=3
 
       - script: npx nx-cloud stop-all-agents
         condition: always()
 ```
 
+You can also use our [ci-workflow generator](https://nx.app/packages/workspace/generators/ci-workflow) to generate the pipeline file.
+
 Learn more about [configuring your CI](https://nx.app/docs/configuring-ci) environment using Nx Cloud with [Distributed Caching](https://nx.app/docs/distributed-caching) and [Distributed Task Execution](https://nx.app/docs/distributed-execution) in the Nx Cloud docs.
diff --git a/docs/shared/monorepo-ci-circle-ci.md b/docs/shared/monorepo-ci-circle-ci.md
@@ -107,4 +107,6 @@ workflows:
       - main
 ```
 
+You can also use our [ci-workflow generator](https://nx.app/packages/workspace/generators/ci-workflow) to generate the configuration file.
+
 Learn more about [configuring your CI](https://nx.app/docs/configuring-ci) environment using Nx Cloud with [Distributed Caching](https://nx.app/docs/distributed-caching) and [Distributed Task Execution](https://nx.app/docs/distributed-execution) in the Nx Cloud docs.
diff --git a/docs/shared/monorepo-ci-github-actions.md b/docs/shared/monorepo-ci-github-actions.md
@@ -82,4 +82,6 @@ jobs:
       number-of-agents: 3
 ```
 
+You can also use our [ci-workflow generator](https://nx.app/packages/workspace/generators/ci-workflow) to generate the workflow file.
+
 Learn more about [configuring your CI](https://nx.app/docs/configuring-ci) environment using Nx Cloud with [Distributed Caching](https://nx.app/docs/distributed-caching) and [Distributed Task Execution](https://nx.app/docs/distributed-execution) in the Nx Cloud docs.
diff --git a/packages/workspace/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__ b/packages/workspace/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__
@@ -64,4 +64,4 @@ jobs:
         displayName: Run build
       - script: <%= packageManagerPrefix %> nx-cloud stop-all-agents
         condition: always()
-        displayName: Stop all Nx-Cloud agents
+        displayName: Stop all Nx-Cloud agents
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__
@@ -81,4 +81,4 @@ workflows:
             parameters:
               ordinal: [1, 2, 3]
       - main
-          name: Nx Cloud Main
+          name: Nx Cloud Main
diff --git a/packages/workspace/src/generators/ci-workflow/schema.json b/packages/workspace/src/generators/ci-workflow/schema.json
@@ -9,11 +9,7 @@
     "ci": {
       "type": "string",
       "description": "CI provider.",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "default": "github",
+      "enum": ["github", "circleci", "azure"],
       "x-prompt": {
         "message": "What is your target CI provider?",
         "type": "list",