Made documentation more clear for Test-VSTeamYamlPipeline (#399)

MethodsAndPractices · Jun 25, 2021 · fe98db4 · fe98db4
1 parent c442233
commit fe98db4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.docs/Test-VSTeamYamlPipeline.md b/.docs/Test-VSTeamYamlPipeline.md
@@ -83,6 +83,8 @@ PipelineId
 
 Currently the API that is used by this cmdlet is only supporting YAML pipelines without template references. This will be supported soon. see the issue in GitHub: [https://github.com/microsoft/azure-pipelines-yaml/issues/34#issuecomment-591092498](https://github.com/microsoft/azure-pipelines-yaml/issues/34#issuecomment-591092498)
 
+This cmdlet is not starting a pipeline run, but rather trying to resolve the full YAML code. It will not check if the task themselves work. See here for more info [https://www.razorspoint.com/2020/03/13/how-to-preview-and-test-a-changing-yaml-pipeline-on-azure-devops/](https://www.razorspoint.com/2020/03/13/how-to-preview-and-test-a-changing-yaml-pipeline-on-azure-devops/)
+
 <!-- #include "./common/prerequisites.md" -->
 
 ## RELATED LINKS

diff --git a/.docs/synopsis/Test-VSTeamYamlPipeline.md b/.docs/synopsis/Test-VSTeamYamlPipeline.md
@@ -1 +1 @@
-Tests the commited YAML pipeline files to check for inconsitencies. Now, you can try out a YAML pipeline without committing it to a repo or running it. Given an existing pipeline and an optional new YAML payload, this function will give you back the full YAML pipeline.
+Tests the commited YAML pipeline files to check for inconsitencies like syntax, references etc.. Now, you can try out a YAML pipeline without committing it to a repo or running it. Given an existing pipeline and an optional new YAML payload, this function will give you back the full YAML pipeline.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Tests the commited YAML pipeline files to check for inconsitencies. Now, you can try out a YAML pipeline without committing it to a repo or running it. Given an existing pipeline and an optional new YAML payload, this function will give you back the full YAML pipeline.
		Tests the commited YAML pipeline files to check for inconsitencies like syntax, references etc.. Now, you can try out a YAML pipeline without committing it to a repo or running it. Given an existing pipeline and an optional new YAML payload, this function will give you back the full YAML pipeline.