Update readme to add validate readme to sdk workflows

Azure · Oct 23, 2023 · 26cb40f · 26cb40f
1 parent b93862f
commit 26cb40f
Show file tree

Hide file tree

Showing 137 changed files with 711 additions and 30 deletions.
diff --git a/.github/workflows/sdk-assets-assets-in-registry-share-data-using-registry.yml b/.github/workflows/sdk-assets-assets-in-registry-share-data-using-registry.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/assets-in-registry"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-assets-in-registry-share-models-components-environments.yml b/.github/workflows/sdk-assets-assets-in-registry-share-models-components-environments.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/assets-in-registry"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-component-component.yml b/.github/workflows/sdk-assets-component-component.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/component"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-data-data.yml b/.github/workflows/sdk-assets-data-data.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-data-working_with_mltable.yml b/.github/workflows/sdk-assets-data-working_with_mltable.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/data"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-environment-environment.yml b/.github/workflows/sdk-assets-environment-environment.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/environment"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-assets-model-model.yml b/.github/workflows/sdk-assets-model-model.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/assets/model"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...orkflows/sdk-endpoints-batch-deploy-models-custom-outputs-parquet-custom-output-batch.yml b/...orkflows/sdk-endpoints-batch-deploy-models-custom-outputs-parquet-custom-output-batch.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-models/custom-outputs-parquet"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -65,7 +70,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "custom-output-batch.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python custom-output-batch.ipynb custom-output-batch.output.ipynb --log-output
+          papermill -k python custom-output-batch.ipynb custom-output-batch.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-models/custom-outputs-parquet
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...ws/sdk-endpoints-batch-deploy-models-heart-classifier-mlflow-mlflow-for-batch-tabular.yml b/...ws/sdk-endpoints-batch-deploy-models-heart-classifier-mlflow-mlflow-for-batch-tabular.yml
@@ -53,6 +53,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-models/heart-classifier-mlflow"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -67,7 +72,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "mlflow-for-batch-tabular.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python mlflow-for-batch-tabular.ipynb mlflow-for-batch-tabular.output.ipynb --log-output
+          papermill -k python mlflow-for-batch-tabular.ipynb mlflow-for-batch-tabular.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-models/heart-classifier-mlflow
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...endpoints-batch-deploy-models-huggingface-text-summarization-text-summarization-batch.yml b/...endpoints-batch-deploy-models-huggingface-text-summarization-text-summarization-batch.yml
@@ -53,6 +53,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-models/huggingface-text-summarization"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -67,7 +72,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "text-summarization-batch.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python text-summarization-batch.ipynb text-summarization-batch.output.ipynb --log-output
+          papermill -k python text-summarization-batch.ipynb text-summarization-batch.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-models/huggingface-text-summarization
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...lows/sdk-endpoints-batch-deploy-models-imagenet-classifier-imagenet-classifier-mlflow.yml b/...lows/sdk-endpoints-batch-deploy-models-imagenet-classifier-imagenet-classifier-mlflow.yml
@@ -53,6 +53,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-models/imagenet-classifier"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -67,7 +72,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "imagenet-classifier-mlflow.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python imagenet-classifier-mlflow.ipynb imagenet-classifier-mlflow.output.ipynb --log-output
+          papermill -k python imagenet-classifier-mlflow.ipynb imagenet-classifier-mlflow.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-models/imagenet-classifier
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/.github/workflows/sdk-endpoints-batch-deploy-models-mnist-classifier-mnist-batch.yml b/.github/workflows/sdk-endpoints-batch-deploy-models-mnist-classifier-mnist-batch.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-models/mnist-classifier"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -65,7 +70,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "mnist-batch.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python mnist-batch.ipynb mnist-batch.output.ipynb --log-output
+          papermill -k python mnist-batch.ipynb mnist-batch.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-models/mnist-classifier
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...endpoints-batch-deploy-pipelines-batch-scoring-with-preprocessing-sdk-deploy-and-test.yml b/...endpoints-batch-deploy-pipelines-batch-scoring-with-preprocessing-sdk-deploy-and-test.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-pipelines/batch-scoring-with-preprocessing"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -65,7 +70,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "sdk-deploy-and-test.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb --log-output
+          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-pipelines/batch-scoring-with-preprocessing
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/.github/workflows/sdk-endpoints-batch-deploy-pipelines-hello-batch-sdk-deploy-and-test.yml b/.github/workflows/sdk-endpoints-batch-deploy-pipelines-hello-batch-sdk-deploy-and-test.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-pipelines/hello-batch"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -65,7 +70,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "sdk-deploy-and-test.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb --log-output
+          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-pipelines/hello-batch
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...ows/sdk-endpoints-batch-deploy-pipelines-training-with-components-sdk-deploy-and-test.yml b/...ows/sdk-endpoints-batch-deploy-pipelines-training-with-components-sdk-deploy-and-test.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/batch/deploy-pipelines/training-with-components"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";
@@ -65,7 +70,7 @@ jobs:
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" generate_workspace_config "../../.azureml/config.json";
           bash "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh" replace_template_values "sdk-deploy-and-test.ipynb";
           [ -f "../../.azureml/config" ] && cat "../../.azureml/config";
-          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb --log-output
+          papermill -k python sdk-deploy-and-test.ipynb sdk-deploy-and-test.output.ipynb
       working-directory: sdk/python/endpoints/batch/deploy-pipelines/training-with-components
     - name: upload notebook's working folder as an artifact
       if: ${{ always() }}

diff --git a/...ws/sdk-endpoints-online-custom-container-online-endpoints-custom-container-multimodel.yml b/...ws/sdk-endpoints-online-custom-container-online-endpoints-custom-container-multimodel.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/custom-container"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...hub/workflows/sdk-endpoints-online-custom-container-online-endpoints-custom-container.yml b/...hub/workflows/sdk-endpoints-online-custom-container-online-endpoints-custom-container.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/custom-container"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...hub/workflows/sdk-endpoints-online-custom-container-triton-online-endpoints-triton-cc.yml b/...hub/workflows/sdk-endpoints-online-custom-container-triton-online-endpoints-triton-cc.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/custom-container/triton"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...ub/workflows/sdk-endpoints-online-kubernetes-kubernetes-online-endpoints-safe-rollout.yml b/...ub/workflows/sdk-endpoints-online-kubernetes-kubernetes-online-endpoints-safe-rollout.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/kubernetes"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...rkflows/sdk-endpoints-online-kubernetes-kubernetes-online-endpoints-simple-deployment.yml b/...rkflows/sdk-endpoints-online-kubernetes-kubernetes-online-endpoints-simple-deployment.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/kubernetes"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-endpoints-online-llm-langchain-1_langchain_basic_deploy.yml b/.github/workflows/sdk-endpoints-online-llm-langchain-1_langchain_basic_deploy.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/llm/langchain"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-endpoints-online-llm-semantic-kernel-1_semantic_http_server.yml b/.github/workflows/sdk-endpoints-online-llm-semantic-kernel-1_semantic_http_server.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/llm/semantic-kernel"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...sdk-endpoints-online-managed-managed-identities-online-endpoints-managed-identity-sai.yml b/...sdk-endpoints-online-managed-managed-identities-online-endpoints-managed-identity-sai.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/managed/managed-identities"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/...sdk-endpoints-online-managed-managed-identities-online-endpoints-managed-identity-uai.yml b/...sdk-endpoints-online-managed-managed-identities-online-endpoints-managed-identity-uai.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/managed/managed-identities"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-endpoints-online-managed-online-endpoints-binary-payloads.yml b/.github/workflows/sdk-endpoints-online-managed-online-endpoints-binary-payloads.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/managed"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-endpoints-online-managed-online-endpoints-inference-schema.yml b/.github/workflows/sdk-endpoints-online-managed-online-endpoints-inference-schema.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/managed"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";

diff --git a/.github/workflows/sdk-endpoints-online-managed-online-endpoints-keyvault.yml b/.github/workflows/sdk-endpoints-online-managed-online-endpoints-keyvault.yml
@@ -51,6 +51,11 @@ jobs:
           bash setup.sh
       working-directory: sdk/python
       continue-on-error: true
+    - name: validate readme
+      run: |
+          bash check-readme.sh "${{ github.workspace }}" "${{ github.workspace }}/sdk/python/endpoints/online/managed"
+      working-directory: infra/bootstrapping
+      continue-on-error: false
     - name: setup-cli
       run: |
           source "${{ github.workspace }}/infra/bootstrapping/sdk_helpers.sh";