Add readme check (#2955)

* Add script to check README.md and README template

* Refactor check-readme.sh and add messages

* Add step to cli-assets-component-pipeline workflow to test

* Update workflow

* Update workflow

* Fix syntax error

* Update action

* Fix typo

* Add exclusion logic

* Try adding readme validation to readme.py

* Update workflows with readme.py

* Update workflows with readme.py

* Update workflows with readme.py

* Update workflows with readme.py

* Fix github workspace variable

* Fix github workspace variables for exclusion check

* Fix exclusion logic

* Update readme exclusions

* Revert accidental change

* Update readme_exclusions.txt

* Revert accidental change to working directory

* Update check-readme.sh

* Update exclusion logic and file name

* Add debug message

* Update exclusion logic and file name

* FIx working directory file names

* Update exclusion logic and file name

* Add debugging statements

* Remove debugging statements

* Update readme.py and regenerate cli workflows

* Update working-directory

* Update readme to add validate readme to sdk workflows

* Move templates folder inside infra

* Add validate readme check to tutorials and sdk/python files

* Fix readme.py and revert unintended changes

* Revert unnecessary changes and update readme_validation_exclusions.txt

* Update exclusions list

* Update template

* Update readme_validation_exclusions.txt

* Update exclusions

* Replace check-readme.sh with check-readme.py

* Update readme template

* Update check-readme.py with Kevin's suggestions

* Remove 2nd CLI argument

* Add debugging messages

* Add debugging messages

* Add debugging messages

* Update debugging messages

* Update debugging messages

* Strip whitespace

* Convert sample path to string

* Fix exclusions

* Remove debugging messages

* re-format with black

* Manually update one sample with logging logic to test

* Regenerate resolved notebooks

* Remove appinsights logging step

* Exclude /home/runner/work/azureml-examples/azureml-examples/cli/jobs/automl-standalone-jobs/cli-automl-forecasting-task-github-dau

* Revert changes to notebooks

* Add whitespace back

.github/workflows/cli-assets-component-pipeline.yml

@@ -41,9 +41,32 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/component"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
-          az ml component create -f assets/component/pipeline.yml
+          log_output=$(az ml component create -f assets/component/pipeline.yml 2>&1)
+          echo "$log_output" > create-asset.log
+          cat create-asset.log
       working-directory: cli
+    - name: Determine Failure Reason
+      run: |
+        failure_reason="N/A"
+        if [ "${{ job.status }}" == "failure" ]; then
+          if grep -q "ResourceNotReady" create-asset.log; then
+            failure_reason = "ResourceNotReady"
+          elif grep -q "quota" create-asset.log; then
+            failure_reason="QuotaIssue"
+          elif grep -q "ParentResourceNotFound" create-asset.log; then
+            failure_reason="ParentResourceNotFound"
+          else
+            failure_reason="UncategorizedFailure"
+          fi
+        fi
+        echo "FAILURE_REASON=$failure_reason" >> $GITHUB_ENV
+      working-directory: cli

.github/workflows/cli-assets-component-train.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/component"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-file-https.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-file-wasbs.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-file.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-folder-https.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-folder.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-cloud-mltable.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-iris-csv-example.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-local-file.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-local-folder-sampledata.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-local-folder.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-local-mltable.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-data-public-file-https.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-environment-docker-context.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/environment"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-environment-docker-image.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/environment"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-model-local-file.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/model"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-assets-model-local-mlflow.yml

@@ -41,6 +41,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/assets/model"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: create asset
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

.github/workflows/cli-endpoints-batch-deploy-models-custom-outputs-parquet-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-models/custom-outputs-parquet"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -68,4 +73,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n tomoutputsparquetendpoint8741 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-models-heart-classifier-mlflow-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-models/heart-classifier-mlflow"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n tclassifiermlflowendpoint3191 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-models-huggingface-text-summarization-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-models/huggingface-text-summarization"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -68,4 +73,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n textsummarizationendpoint2742 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-models-imagenet-classifier-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-models/imagenet-classifier"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n imagenetclassifierendpoint3948 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-models-mnist-classifier-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-models/mnist-classifier"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n lsmnistclassifierendpoint9980 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-pipelines-batch-scoring-with-preprocessing-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-pipelines/batch-scoring-with-preprocessing"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -68,4 +73,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n withpreprocessingendpoint6601 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-pipelines-hello-batch-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-pipelines/hello-batch"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -68,4 +73,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n pelineshellobatchendpoint9006 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-batch-deploy-pipelines-training-with-components-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/batch/deploy-pipelines/training-with-components"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml batch-endpoint delete -n ingwithcomponentsendpoint9219 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-minimal-multimodel-minimal-multimodel-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/minimal/multimodel"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n minimalmultimodelendpoint9199 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-minimal-single-model-conda-in-dockerfile-minimal-single-model-conda-in-dockerfile-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/minimal/single-model/conda-in-dockerfile"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n condaindockerfileendpoint3179 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-minimal-single-model-minimal-single-model-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/minimal/single-model"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n inimalsinglemodelendpoint2770 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-mlflow-multideployment-scikit-mlflow-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/mlflow/multideployment-scikit"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n ymentscikitmlflowendpoint4848 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-r-multimodel-plumber-r-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/r/multimodel-plumber"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n ultimodelplumberrendpoint9536 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-torchserve-densenet-torchserve-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/torchserve/densenet"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n densenettorchserveendpoint7556 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-custom-container-triton-single-model-triton-cc-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/custom-container/triton/single-model"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n glemodeltritonccendpoint4238 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-kubernetes-kubernetes-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/kubernetes"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -68,4 +73,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n berneteskubernetesendpoint4232 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-managed-sample-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/managed/sample"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -75,4 +80,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n linemanagedsampleendpoint6303 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-managed-vnet-mlflow-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/managed/vnet/mlflow"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n managedvnetmlflowendpoint6555 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-endpoints-online-managed-vnet-sample-endpoint.yml

@@ -42,6 +42,11 @@ jobs:
           bash setup.sh
       working-directory: cli
       continue-on-error: true
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/endpoints/online/managed/vnet/sample"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: delete endpoint if existing
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -61,4 +66,4 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           az ml online-endpoint delete -n managedvnetsampleendpoint8383 -y
-      working-directory: cli
+      working-directory: cli

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-classification-task-bankmarketing-cli-automl-classification-task-bankmarketing.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-classification-task-bankmarketing.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-classification-task-bankmarketing
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-classification-task-bankmarketing"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-forecasting-bike-share-cli-automl-forecasting-task-bike-share.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-forecasting-task-bike-share.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-forecasting-bike-share
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-forecasting-bike-share"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-forecasting-orange-juice-sales-cli-automl-forecasting-orange-juice-sales.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-forecasting-orange-juice-sales.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-forecasting-orange-juice-sales
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-forecasting-orange-juice-sales"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-forecasting-task-energy-demand-cli-automl-forecasting-task-energy-demand.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-forecasting-task-energy-demand.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-forecasting-task-energy-demand
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-forecasting-task-energy-demand"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-forecasting-task-github-dau-cli-automl-forecasting-task-github-dau.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-forecasting-task-github-dau.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-forecasting-task-github-dau
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-forecasting-task-github-dau"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-classification-multiclass-task-fridge-items-cli-automl-image-classification-multiclass-task-fridge-items-automode.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-classification-multiclass-task-fridge-items-automode.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multiclass-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multiclass-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-classification-multiclass-task-fridge-items-cli-automl-image-classification-multiclass-task-fridge-items.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-classification-multiclass-task-fridge-items.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multiclass-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multiclass-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-classification-multilabel-task-fridge-items-cli-automl-image-classification-multilabel-task-fridge-items-automode.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-classification-multilabel-task-fridge-items-automode.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multilabel-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multilabel-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-classification-multilabel-task-fridge-items-cli-automl-image-classification-multilabel-task-fridge-items.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-classification-multilabel-task-fridge-items.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multilabel-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-classification-multilabel-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-instance-segmentation-task-fridge-items-cli-automl-image-instance-segmentation-task-fridge-items-automode.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-instance-segmentation-task-fridge-items-automode.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-instance-segmentation-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-instance-segmentation-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-instance-segmentation-task-fridge-items-cli-automl-image-instance-segmentation-task-fridge-items.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-instance-segmentation-task-fridge-items.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-instance-segmentation-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-instance-segmentation-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-object-detection-task-fridge-items-cli-automl-image-object-detection-task-fridge-items-automode.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-object-detection-task-fridge-items-automode.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-object-detection-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-object-detection-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-image-object-detection-task-fridge-items-cli-automl-image-object-detection-task-fridge-items.yml

@@ -52,3 +52,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../run-job.sh cli-automl-image-object-detection-task-fridge-items.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-image-object-detection-task-fridge-items
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-image-object-detection-task-fridge-items"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-regression-task-hardware-perf-cli-automl-regression-task-hardware-perf.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-regression-task-hardware-perf.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-regression-task-hardware-perf
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-regression-task-hardware-perf"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-text-classification-multilabel-paper-cat-cli-automl-text-classification-multilabel-paper-cat.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-text-classification-multilabel-paper-cat.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-text-classification-multilabel-paper-cat
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-text-classification-multilabel-paper-cat"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-text-classification-newsgroup-cli-automl-text-classification-newsgroup.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-text-classification-newsgroup.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-text-classification-newsgroup
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-text-classification-newsgroup"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-text-ner-conll-cli-automl-text-ner-conll2003.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-text-ner-conll2003.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-text-ner-conll
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-text-ner-conll"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-automl-standalone-jobs-cli-automl-text-ner-conll-distributed-sweeping-cli-automl-text-ner-conll2003-distributed-sweeping.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh cli-automl-text-ner-conll2003-distributed-sweeping.yml
       working-directory: cli/jobs/automl-standalone-jobs/cli-automl-text-ner-conll-distributed-sweeping
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/automl-standalone-jobs/cli-automl-text-ner-conll-distributed-sweeping"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-automl-hello-automl-job-basic.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh hello-automl-job-basic.yml
       working-directory: cli/jobs/basics/hello-automl
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics/hello-automl"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-code.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-code.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-data-uri-folder.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-data-uri-folder.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-dataset.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-dataset.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-git.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-git.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-interactive.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-interactive.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-iris-datastore-file.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-iris-datastore-file.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-iris-datastore-folder.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-iris-datastore-folder.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-iris-file.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-iris-file.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-iris-folder.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-iris-folder.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-iris-literal.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-iris-literal.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-mlflow.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-mlflow.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-model-as-input.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-model-as-input.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-model-as-output.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-model-as-output.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-notebook.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-notebook.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-abc.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-abc.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-customize-output-file.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-customize-output-file.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-customize-output-folder.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-customize-output-folder.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-default-artifacts.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-default-artifacts.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-io.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-io.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline-settings.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline-settings.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-pipeline.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-pipeline.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-sweep.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-sweep.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world-env-var.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world-env-var.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world-input.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world-input.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world-org.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world-org.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world-output-data.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world-output-data.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world-output.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world-output.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-basics-hello-world.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../run-job.sh hello-world.yml
       working-directory: cli/jobs/basics
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/basics"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-deepspeed-deepspeed-autotuning-job.yml

@@ -49,3 +49,8 @@ jobs:
           bash -x generate-yml.sh
           bash -x ../../../run-job.sh job.yml
       working-directory: cli/jobs/deepspeed/deepspeed-autotuning
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/deepspeed/deepspeed-autotuning"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-deepspeed-deepspeed-training-job.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh job.yml
       working-directory: cli/jobs/deepspeed/deepspeed-training
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/deepspeed/deepspeed-training"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-nebulaml-PyTorch_CNN_MNIST-job.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh job.yml
       working-directory: cli/jobs/nebulaml/PyTorch_CNN_MNIST
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/nebulaml/PyTorch_CNN_MNIST"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-parallel-1a_oj_sales_prediction-pipeline.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/parallel/1a_oj_sales_prediction
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/parallel/1a_oj_sales_prediction"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-parallel-2a_iris_batch_prediction-pipeline.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/parallel/2a_iris_batch_prediction
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/parallel/2a_iris_batch_prediction"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-parallel-3a_mnist_batch_identification-pipeline.yml

@@ -48,3 +48,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/parallel/3a_mnist_batch_identification
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/parallel/3a_mnist_batch_identification"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-classification-task-bankmarketing-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-classification-task-bankmarketing-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-classification-task-bankmarketing-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-forecasting-demand-with-pipeline-components-cli-automl-forecasting-demand-hierarchical-timeseries-hts_evaluation_pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../../run-job.sh hts_evaluation_pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-forecasting-demand-with-pipeline-components/cli-automl-forecasting-demand-hierarchical-timeseries
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-forecasting-demand-with-pipeline-components/cli-automl-forecasting-demand-hierarchical-timeseries"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-forecasting-demand-with-pipeline-components-cli-automl-forecasting-demand-many-models-many_models_evaluation_pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../../run-job.sh many_models_evaluation_pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-forecasting-demand-with-pipeline-components/cli-automl-forecasting-demand-many-models
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-forecasting-demand-with-pipeline-components/cli-automl-forecasting-demand-many-models"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-regression-housepricing-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-regression-housepricing-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-regression-housepricing-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-text-classification-multilabel-paper-categorization-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-text-classification-multilabel-paper-categorization-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-text-classification-multilabel-paper-categorization-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-text-classification-newsgroup-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-text-classification-newsgroup-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-text-classification-newsgroup-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-cli-automl-text-ner-conll-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/cli-automl-text-ner-conll-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/cli-automl-text-ner-conll-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-forecasting-energy-demand-pipeline-pipeline.yml

@@ -49,3 +49,8 @@ jobs:
           source "${{ github.workspace }}/infra/bootstrapping/init_environment.sh";
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/forecasting-energy-demand-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/forecasting-energy-demand-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-image-instance-segmentation-task-fridge-items-pipeline-pipeline.yml

@@ -53,3 +53,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/image-instance-segmentation-task-fridge-items-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/image-instance-segmentation-task-fridge-items-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false

.github/workflows/cli-jobs-pipelines-automl-image-multiclass-classification-fridge-items-pipeline-pipeline.yml

@@ -53,3 +53,8 @@ jobs:
           python prepare_data.py --subscription $SUBSCRIPTION_ID --group $RESOURCE_GROUP_NAME --workspace $WORKSPACE_NAME
           bash -x ../../../../run-job.sh pipeline.yml
       working-directory: cli/jobs/pipelines/automl/image-multiclass-classification-fridge-items-pipeline
+    - name: validate readme
+      run: |
+          python check-readme.py "${{ github.workspace }}/cli/jobs/pipelines/automl/image-multiclass-classification-fridge-items-pipeline"
+      working-directory: infra/bootstrapping
+      continue-on-error: false