Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made documentation more clear for Test-VSTeamYamlPipeline #399

Merged
merged 1 commit into from
Jun 25, 2021
Merged

Made documentation more clear for Test-VSTeamYamlPipeline #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .docs/Test-VSTeamYamlPipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .docs/synopsis/Test-VSTeamYamlPipeline.md
View file
Open in desktop
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.